[tcgc] .name -> .nameInClient on SdkModelPropertyTypes

.chronus/changes/name_in_client-2024-2-19-15-2-6.md

@@ -0,0 +1,7 @@
+---
+changeKind: deprecation
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Users should call `.name` instead of `.nameInClient` on `SdkModelPropertyType`s

packages/typespec-client-generator-core/doc/types.tsp

@@ -248,7 +248,7 @@ model SdkModelType extends SdkType {
  * @property kind: The kind of property
  * @property __raw: The original TSP property
  * @property type: The type of the property
- * @property nameInClient: The name of the property in our client SDKs
+ * @property name: The name of the property in our client SDKs
  * @property description: Description for the property
  * @property details: Optional details of the property
  * @property apiVersions: Api versions the property is available for
@@ -260,7 +260,7 @@ model SdkModelType extends SdkType {
 model SdkModelPropertyType {
   __raw?: ModelProperty;
   type: SdkType;
-  nameInClient: string;
+  name: string;
   description?: string;
   details?: string;
   apiVersions: string[];
@@ -291,13 +291,13 @@ model SdkModelPropertyType {
  *     kind: "model",
  *     properties: [
  *       {
- *         nameInClient: "path_param",
+ *         name: "path_param",
  *         serializedName: "pathParam"
  *         type: "string",
  *         kind: "path"
  *       },
  *       {
- *         nameInClient: "query_param",
+ *         name: "query_param",
  *         name: "queryParam",
  *         type: "string",
  *         kind: "query"
@@ -307,7 +307,7 @@ model SdkModelPropertyType {
  *   kind: "method"
  * }
  * PathServiceParameter: {
- *   nameInClient: "pathParam",
+ *   name: "pathParam",
  *   serializedName: "pathParam",
  *   type: "string",
  *   kind: "path",
@@ -317,7 +317,7 @@ model SdkModelPropertyType {
  *   }
  * }
  * QueryServiceParameter: {
- *   nameInClient: "queryParam",
+ *   name: "queryParam",
  *   serializedName: "queryParam",
  *   type: "string",
  *   kind: "query",

packages/typespec-client-generator-core/src/interfaces.ts

@@ -288,7 +288,12 @@ export interface SdkCredentialType extends SdkTypeBase {
 export interface SdkModelPropertyTypeBase {
   __raw?: ModelProperty;
   type: SdkType;
+  /**
+   * @deprecated This property is deprecated. Use `.name` instead.
+   * https://github.com/Azure/typespec-azure/issues/446
+   */
   nameInClient: string;
+  name: string;
   description?: string;
   details?: string;
   apiVersions: string[];

packages/typespec-client-generator-core/src/package.ts

@@ -92,10 +92,12 @@ function getSdkHttpBodyParameters<TOptions extends object>(
     const bodyType = diagnostics.pipe(
       getClientTypeWithDiagnostics(context, tspBody.type, httpOperation.operation)
     );
+    const name = "body";
     return diagnostics.wrap([
       {
         kind: "body",
-        nameInClient: "body",
+        nameInClient: name,
+        name,
         description: getDocHelper(context, tspBody.type).description,
         details: getDocHelper(context, tspBody.type).details,
         onClient: false,
@@ -115,7 +117,7 @@ function getSdkHttpBodyParameters<TOptions extends object>(
     })
   );
   const methodBodyParameter = methodParameters.find(
-    (x) => x.nameInClient === getPropertyNames(context, tspBody.parameter!)[0]
+    (x) => x.name === getPropertyNames(context, tspBody.parameter!)[0]
   );
   if (body.kind !== "body") throw new Error("blah");
   if (methodBodyParameter) {
@@ -149,7 +151,7 @@ function getSdkHttpBodyParameters<TOptions extends object>(
 function createContentTypeOrAcceptHeader(
   bodyObject: SdkBodyParameter | SdkHttpResponse
 ): Omit<SdkMethodParameter, "kind"> {
-  const nameInClient = bodyObject.kind === "body" ? "contentType" : "accept";
+  const name = bodyObject.kind === "body" ? "contentType" : "accept";
   let type: SdkType = {
     kind: "string",
     encode: "string",
@@ -165,7 +167,7 @@ function createContentTypeOrAcceptHeader(
   if (
     bodyObject.contentTypes &&
     bodyObject.contentTypes.length === 1 &&
-    (/json/.test(bodyObject.contentTypes[0]) || nameInClient === "accept")
+    (/json/.test(bodyObject.contentTypes[0]) || name === "accept")
   ) {
     // in this case, we just want a content type of application/json
     type = {
@@ -178,7 +180,8 @@ function createContentTypeOrAcceptHeader(
   // No need for clientDefaultValue because it's a constant, it only has one value
   return {
     type,
-    nameInClient,
+    nameInClient: name,
+    name,
     apiVersions: bodyObject.apiVersions,
     isApiVersionParam: false,
     onClient: false,
@@ -244,7 +247,7 @@ function getSdkHttpOperation<TOptions extends object>(
       kind: "header",
       serializedName: "Accept",
     });
-    if (!methodParameters.some((m) => m.nameInClient === "accept")) {
+    if (!methodParameters.some((m) => m.name === "accept")) {
       methodParameters.push({
         ...acceptBase,
         kind: "method",
@@ -490,18 +493,16 @@ function getParameterMappingHelper<
     if (!context.__api_version_parameter) throw new Error("No api version on the client");
     return [context.__api_version_parameter];
   }
-  const correspondingMethodParameter = method.parameters.find(
-    (x) => x.nameInClient === serviceParam.nameInClient
-  );
+  const correspondingMethodParameter = method.parameters.find((x) => x.name === serviceParam.name);
   if (correspondingMethodParameter) {
     return [correspondingMethodParameter];
   }
   function paramInProperties(param: SdkModelPropertyType, type: SdkType): boolean {
     if (type.kind !== "model") return false;
     return Array.from(type.properties.values())
       .filter((x) => x.kind === "property")
-      .map((x) => x.nameInClient)
-      .includes(param.nameInClient);
+      .map((x) => x.name)
+      .includes(param.name);
   }
   const serviceParamType = serviceParam.type;
   if (serviceParam.kind === "body" && serviceParamType.kind === "model") {
@@ -520,7 +521,7 @@ function getParameterMappingHelper<
   for (const methodParam of method.parameters) {
     if (methodParam.type.kind === "model") {
       for (const prop of methodParam.type.properties) {
-        if (prop.nameInClient === serviceParam.nameInClient) {
+        if (prop.name === serviceParam.name) {
           return [prop];
         }
       }
@@ -625,10 +626,12 @@ function getDefaultSdkEndpointParameter<
       encode: "string",
     };
   }
+  const name = "endpoint";
   return [
     {
       kind: "endpoint",
-      nameInClient: "endpoint",
+      nameInClient: name,
+      name,
       description: "Service host",
       onClient: true,
       urlEncode: false,

packages/typespec-client-generator-core/src/types.ts

@@ -420,7 +420,7 @@ function addDiscriminatorToModelType(
                 createDiagnostic({
                   code: "discriminator-not-constant",
                   target: type,
-                  format: { discriminator: property.nameInClient },
+                  format: { discriminator: property.name },
                 })
               );
             } else if (typeof property.type.value !== "string") {
@@ -429,7 +429,7 @@ function addDiscriminatorToModelType(
                   code: "discriminator-not-string",
                   target: type,
                   format: {
-                    discriminator: property.nameInClient,
+                    discriminator: property.name,
                     discriminatorValue: String(property.type.value),
                   },
                 })
@@ -469,13 +469,15 @@ function addDiscriminatorToModelType(
         encode: "string",
       };
     }
+    const name = discriminator.propertyName;
     model.properties.push({
       kind: "property",
       optional: false,
       discriminator: true,
       serializedName: discriminator.propertyName,
       type: discriminatorType!,
-      nameInClient: discriminator.propertyName,
+      nameInClient: name,
+      name,
       onClient: false,
       apiVersions: getAvailableApiVersions(context, type),
       isApiVersionParam: false,
@@ -933,10 +935,12 @@ export function getSdkCredentialParameter(
 ): SdkCredentialParameter | undefined {
   const auth = getAuthentication(context.program, client.service);
   if (!auth) return undefined;
+  const name = "credential";
   return {
     type: getSdkCredentialType(client, auth),
     kind: "credential",
-    nameInClient: "credential",
+    nameInClient: name,
+    name,
     description: "Credential used to authenticate requests to the service.",
     apiVersions: getAvailableApiVersions(context, client.service),
     onClient: true,
@@ -968,13 +972,15 @@ export function getSdkModelPropertyType(
     propertyType = getSdkEnum(context, knownValues, options.operation);
   }
   const docWrapper = getDocHelper(context, type);
+  const name = getPropertyNames(context, type)[0];
   const base = {
     __raw: type,
     description: docWrapper.description,
     details: docWrapper.details,
     apiVersions: getAvailableApiVersions(context, type),
     type: propertyType,
-    nameInClient: getPropertyNames(context, type)[0],
+    nameInClient: name,
+    name,
     onClient: false,
     optional: type.optional,
   };