From 7ef890dddff15d28da7e939e09eeff7246a553e7 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Tue, 19 Mar 2024 14:59:38 -0400 Subject: [PATCH 1/4] deprecate .nameInClient and add .name Please enter the commit message for your changes. Lines starting --- .../doc/types.tsp | 12 +- .../src/interfaces.ts | 4 + .../src/package.ts | 29 ++- .../src/types.ts | 16 +- .../test/package.test.ts | 240 ++++++++---------- .../test/types.test.ts | 46 ++-- 6 files changed, 170 insertions(+), 177 deletions(-) diff --git a/packages/typespec-client-generator-core/doc/types.tsp b/packages/typespec-client-generator-core/doc/types.tsp index 9e4ac8a265..cd481ae68d 100644 --- a/packages/typespec-client-generator-core/doc/types.tsp +++ b/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", diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts index ee779c06c5..de1297938c 100644 --- a/packages/typespec-client-generator-core/src/interfaces.ts +++ b/packages/typespec-client-generator-core/src/interfaces.ts @@ -288,7 +288,11 @@ export interface SdkCredentialType extends SdkTypeBase { export interface SdkModelPropertyTypeBase { __raw?: ModelProperty; type: SdkType; + /** + * @deprecated This property is deprecated. Use `.name` instead + */ nameInClient: string; + name: string; description?: string; details?: string; apiVersions: string[]; diff --git a/packages/typespec-client-generator-core/src/package.ts b/packages/typespec-client-generator-core/src/package.ts index 8d4f08d0d3..8de058c2be 100644 --- a/packages/typespec-client-generator-core/src/package.ts +++ b/packages/typespec-client-generator-core/src/package.ts @@ -91,10 +91,12 @@ function getSdkHttpBodyParameters( 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, @@ -114,7 +116,7 @@ function getSdkHttpBodyParameters( }) ); 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) { @@ -148,7 +150,7 @@ function getSdkHttpBodyParameters( function createContentTypeOrAcceptHeader( bodyObject: SdkBodyParameter | SdkHttpResponse ): Omit { - const nameInClient = bodyObject.kind === "body" ? "contentType" : "accept"; + const name = bodyObject.kind === "body" ? "contentType" : "accept"; let type: SdkType = { kind: "string", encode: "string", @@ -164,7 +166,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 = { @@ -177,7 +179,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, @@ -243,7 +246,7 @@ function getSdkHttpOperation( kind: "header", serializedName: "Accept", }); - if (!methodParameters.some((m) => m.nameInClient === "accept")) { + if (!methodParameters.some((m) => m.name === "accept")) { methodParameters.push({ ...acceptBase, kind: "method", @@ -487,9 +490,7 @@ 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]; } @@ -497,8 +498,8 @@ function getParameterMappingHelper< 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") { @@ -517,7 +518,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]; } } @@ -622,10 +623,12 @@ function getDefaultSdkEndpointParameter< encode: "string", }; } + const name = "endpoint"; return [ { kind: "endpoint", - nameInClient: "endpoint", + nameInClient: name, + name, description: "Service host", onClient: true, urlEncode: false, diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts index e468551aca..8178a06320 100644 --- a/packages/typespec-client-generator-core/src/types.ts +++ b/packages/typespec-client-generator-core/src/types.ts @@ -419,7 +419,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") { @@ -428,7 +428,7 @@ function addDiscriminatorToModelType( code: "discriminator-not-string", target: type, format: { - discriminator: property.nameInClient, + discriminator: property.name, discriminatorValue: String(property.type.value), }, }) @@ -468,13 +468,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, @@ -928,10 +930,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, @@ -963,13 +967,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, }; diff --git a/packages/typespec-client-generator-core/test/package.test.ts b/packages/typespec-client-generator-core/test/package.test.ts index 24c2e53308..a6fcd5d942 100644 --- a/packages/typespec-client-generator-core/test/package.test.ts +++ b/packages/typespec-client-generator-core/test/package.test.ts @@ -97,7 +97,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(initialization.properties.length, 1); const endpointParam = initialization.properties[0]; strictEqual(endpointParam.kind, "endpoint"); - strictEqual(endpointParam.nameInClient, "endpoint"); + strictEqual(endpointParam.name, "endpoint"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); strictEqual(endpointParam.type.kind, "constant"); @@ -129,7 +129,7 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; - strictEqual(credentialParam.nameInClient, "credential"); + strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); strictEqual(credentialParam.type.kind, "credential"); @@ -168,7 +168,7 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; - strictEqual(credentialParam.nameInClient, "credential"); + strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); strictEqual(credentialParam.type.kind, "credential"); @@ -213,7 +213,7 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; - strictEqual(credentialParam.nameInClient, "credential"); + strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); strictEqual(credentialParam.type.kind, "union"); @@ -268,7 +268,7 @@ describe("typespec-client-generator-core: package", () => { )[0]; strictEqual(endpointParam.clientDefaultValue, undefined); strictEqual(endpointParam.urlEncode, false); - strictEqual(endpointParam.nameInClient, "endpointInput"); + strictEqual(endpointParam.name, "endpointInput"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); strictEqual(endpointParam.kind, "endpoint"); @@ -277,7 +277,7 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; - strictEqual(credentialParam.nameInClient, "credential"); + strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); strictEqual(credentialParam.type.kind, "credential"); @@ -327,7 +327,7 @@ describe("typespec-client-generator-core: package", () => { const endpointParam = endpointParams[0]; strictEqual(endpointParam.clientDefaultValue, undefined); strictEqual(endpointParam.urlEncode, false); - strictEqual(endpointParam.nameInClient, "endpoint"); + strictEqual(endpointParam.name, "endpoint"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); strictEqual(endpointParam.kind, "endpoint"); @@ -335,7 +335,7 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = endpointParams[1]; strictEqual(apiVersionParam.clientDefaultValue, "v1.0"); strictEqual(apiVersionParam.urlEncode, false); - strictEqual(apiVersionParam.nameInClient, "apiVersion"); + strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); strictEqual(apiVersionParam.kind, "endpoint"); @@ -344,7 +344,7 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; - strictEqual(credentialParam.nameInClient, "credential"); + strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); strictEqual(credentialParam.type.kind, "credential"); @@ -403,7 +403,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(client.apiVersions[0], "2022-12-01-preview"); const apiVersionParam = initialization.properties.filter((p) => p.isApiVersionParam)[0]; - strictEqual(apiVersionParam.nameInClient, "apiVersion"); + strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); strictEqual(apiVersionParam.kind, "method"); @@ -463,7 +463,7 @@ describe("typespec-client-generator-core: package", () => { deepStrictEqual(client.apiVersions, ["2022-12-01-preview", "2022-12-01"]); const apiVersionParam = initialization.properties.filter((p) => p.isApiVersionParam)[0]; - strictEqual(apiVersionParam.nameInClient, "apiVersion"); + strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); strictEqual(apiVersionParam.kind, "method"); @@ -511,7 +511,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(mainClient.methods.length, 1); strictEqual(mainClient.initialization!.properties.length, 1); - strictEqual(mainClient.initialization!.properties[0].nameInClient, "endpoint"); + strictEqual(mainClient.initialization!.properties[0].name, "endpoint"); const clientAccessor = mainClient.methods[0]; strictEqual(clientAccessor.kind, "clientaccessor"); @@ -547,7 +547,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(mainClient.methods.length, 2); strictEqual(mainClient.initialization!.properties.length, 1); - strictEqual(mainClient.initialization!.properties[0].nameInClient, "endpoint"); + strictEqual(mainClient.initialization!.properties[0].name, "endpoint"); const fooAccessor = mainClient.methods[0]; strictEqual(fooAccessor.kind, "clientaccessor"); @@ -616,7 +616,7 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 1); - strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); + strictEqual(client.initialization.properties[0].name, "endpoint"); strictEqual(client.methods.length, 1); @@ -645,9 +645,9 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); - strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); + strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; - strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); + strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); strictEqual(clientApiVersionParam.kind, "method"); @@ -719,7 +719,7 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 1); - strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); + strictEqual(client.initialization.properties[0].name, "endpoint"); const withoutApiVersion = client.methods[0]; strictEqual(withoutApiVersion.kind, "basic"); @@ -745,10 +745,10 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); - strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); + strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; - strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); + strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); strictEqual(clientApiVersionParam.kind, "method"); @@ -790,10 +790,10 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); - strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); + strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; - strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); + strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); strictEqual(clientApiVersionParam.kind, "method"); @@ -811,7 +811,7 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = withApiVersion.operation.parameters[0]; strictEqual(apiVersionParam.kind, "path"); strictEqual(apiVersionParam.serializedName, "apiVersion"); - strictEqual(apiVersionParam.nameInClient, "apiVersion"); + strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.isApiVersionParam, true); strictEqual(apiVersionParam.optional, false); strictEqual(apiVersionParam.onClient, true); @@ -835,7 +835,7 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "path"); + strictEqual(methodParam.name, "path"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -850,7 +850,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "path"); - strictEqual(pathParam.nameInClient, "path"); + strictEqual(pathParam.name, "path"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); strictEqual(pathParam.isApiVersionParam, false); @@ -861,7 +861,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); - strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(pathParam.name, correspondingMethodParams[0].name); }); it("header basic", async () => { @@ -879,7 +879,7 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "header"); + strictEqual(methodParam.name, "header"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -894,7 +894,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(headerParam.kind, "header"); strictEqual(headerParam.serializedName, "header"); - strictEqual(headerParam.nameInClient, "header"); + strictEqual(headerParam.name, "header"); strictEqual(headerParam.optional, false); strictEqual(headerParam.onClient, false); strictEqual(headerParam.isApiVersionParam, false); @@ -903,7 +903,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(headerParam); strictEqual(correspondingMethodParams.length, 1); - strictEqual(headerParam.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(headerParam.name, correspondingMethodParams[0].name); }); it("header collection format", async () => { @@ -938,7 +938,7 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "query"); + strictEqual(methodParam.name, "query"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -952,7 +952,7 @@ describe("typespec-client-generator-core: package", () => { const queryParam = serviceOperation.parameters[0]; strictEqual(queryParam.kind, "query"); strictEqual(queryParam.serializedName, "query"); - strictEqual(queryParam.nameInClient, "query"); + strictEqual(queryParam.name, "query"); strictEqual(queryParam.optional, false); strictEqual(queryParam.onClient, false); strictEqual(queryParam.isApiVersionParam, false); @@ -961,7 +961,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(queryParam); strictEqual(correspondingMethodParams.length, 1); - strictEqual(queryParam.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(queryParam.name, correspondingMethodParams[0].name); }); it("query collection format", async () => { @@ -1000,16 +1000,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 2); - const methodBodyParam = method.parameters.find((x) => x.nameInClient === "body")!; + const methodBodyParam = method.parameters.find((x) => x.name === "body")!; strictEqual(methodBodyParam.kind, "method"); strictEqual(methodBodyParam.optional, false); strictEqual(methodBodyParam.onClient, false); strictEqual(methodBodyParam.isApiVersionParam, false); strictEqual(methodBodyParam.type, sdkPackage.models[0]); - const methodContentTypeParam = method.parameters.find( - (x) => x.nameInClient === "contentType" - )!; + const methodContentTypeParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(methodContentTypeParam.clientDefaultValue, undefined); strictEqual(methodContentTypeParam.type.kind, "constant"); strictEqual(methodContentTypeParam.onClient, false); @@ -1027,11 +1025,11 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); - strictEqual(bodyParameter.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(bodyParameter.name, correspondingMethodParams[0].name); strictEqual(serviceOperation.parameters.length, 1); const contentTypeParam = serviceOperation.parameters[0]; - strictEqual(contentTypeParam.nameInClient, "contentType"); + strictEqual(contentTypeParam.name, "contentType"); strictEqual(contentTypeParam.serializedName, "Content-Type"); strictEqual(contentTypeParam.clientDefaultValue, undefined); strictEqual(contentTypeParam.onClient, false); @@ -1061,16 +1059,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 2); - const methodBodyParam = method.parameters.find((x) => x.nameInClient === "body")!; + const methodBodyParam = method.parameters.find((x) => x.name === "body")!; strictEqual(methodBodyParam.kind, "method"); strictEqual(methodBodyParam.optional, true); strictEqual(methodBodyParam.onClient, false); strictEqual(methodBodyParam.isApiVersionParam, false); strictEqual(methodBodyParam.type, sdkPackage.models[0]); - const methodContentTypeParam = method.parameters.find( - (x) => x.nameInClient === "contentType" - )!; + const methodContentTypeParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(methodContentTypeParam.clientDefaultValue, undefined); strictEqual(methodContentTypeParam.type.kind, "constant"); strictEqual(methodContentTypeParam.onClient, false); @@ -1088,11 +1084,11 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); - strictEqual(bodyParameter.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(bodyParameter.name, correspondingMethodParams[0].name); strictEqual(serviceOperation.parameters.length, 1); const contentTypeParam = serviceOperation.parameters[0]; - strictEqual(contentTypeParam.nameInClient, "contentType"); + strictEqual(contentTypeParam.name, "contentType"); strictEqual(contentTypeParam.serializedName, "Content-Type"); strictEqual(contentTypeParam.clientDefaultValue, undefined); strictEqual(contentTypeParam.onClient, false); @@ -1120,14 +1116,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 2); - const methodParam = method.parameters.find((x) => x.nameInClient === "key")!; + const methodParam = method.parameters.find((x) => x.name === "key")!; strictEqual(methodParam.kind, "method"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); strictEqual(methodParam.type.kind, "string"); - const contentTypeParam = method.parameters.find((x) => x.nameInClient === "contentType")!; + const contentTypeParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(contentTypeParam.clientDefaultValue, undefined); strictEqual(contentTypeParam.type.kind, "constant"); strictEqual(contentTypeParam.onClient, false); @@ -1144,10 +1140,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); - strictEqual( - bodyParameter.type.properties[0].nameInClient, - correspondingMethodParams[0].nameInClient - ); + strictEqual(bodyParameter.type.properties[0].name, correspondingMethodParams[0].name); }); it("body alias spread", async () => { @@ -1168,16 +1161,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 2); - const methodParam = method.parameters.find((x) => x.nameInClient === "name")!; + const methodParam = method.parameters.find((x) => x.name === "name")!; strictEqual(methodParam.kind, "method"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); strictEqual(methodParam.type.kind, "string"); - const contentTypeMethodParam = method.parameters.find( - (x) => x.nameInClient === "contentType" - )!; + const contentTypeMethodParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(contentTypeMethodParam.clientDefaultValue, undefined); strictEqual(contentTypeMethodParam.type.kind, "constant"); @@ -1191,14 +1182,11 @@ describe("typespec-client-generator-core: package", () => { strictEqual(bodyParameter.optional, false); strictEqual(bodyParameter.type.kind, "model"); strictEqual(bodyParameter.type.properties.length, 1); - strictEqual(bodyParameter.type.properties[0].nameInClient, "name"); + strictEqual(bodyParameter.type.properties[0].name, "name"); const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); - strictEqual( - bodyParameter.type.properties[0].nameInClient, - correspondingMethodParams[0].nameInClient - ); + strictEqual(bodyParameter.type.properties[0].name, correspondingMethodParams[0].name); }); it("parameter grouping", async () => { @@ -1225,7 +1213,7 @@ describe("typespec-client-generator-core: package", () => { let methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "options"); + strictEqual(methodParam.name, "options"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -1236,28 +1224,28 @@ describe("typespec-client-generator-core: package", () => { strictEqual(requestOptionsModel.properties.length, 3); const headerParamProp = requestOptionsModel.properties.find( - (x): x is SdkHeaderParameter => x.nameInClient === "header" + (x): x is SdkHeaderParameter => x.name === "header" )!; strictEqual(headerParamProp.kind, "header"); - strictEqual(headerParamProp.nameInClient, "header"); + strictEqual(headerParamProp.name, "header"); strictEqual(headerParamProp.optional, false); strictEqual(headerParamProp.onClient, false); strictEqual(headerParamProp.type.kind, "string"); const queryParamProp = requestOptionsModel.properties.find( - (x): x is SdkQueryParameter => x.nameInClient === "query" + (x): x is SdkQueryParameter => x.name === "query" )!; strictEqual(queryParamProp.kind, "query"); - strictEqual(queryParamProp.nameInClient, "query"); + strictEqual(queryParamProp.name, "query"); strictEqual(queryParamProp.optional, false); strictEqual(queryParamProp.onClient, false); strictEqual(queryParamProp.type.kind, "string"); const bodyParamProp = requestOptionsModel.properties.find( - (x): x is SdkBodyParameter => x.nameInClient === "body" + (x): x is SdkBodyParameter => x.name === "body" )!; strictEqual(bodyParamProp.kind, "body"); - strictEqual(bodyParamProp.nameInClient, "body"); + strictEqual(bodyParamProp.name, "body"); strictEqual(bodyParamProp.optional, false); strictEqual(bodyParamProp.onClient, false); strictEqual(bodyParamProp.type.kind, "string"); @@ -1266,7 +1254,7 @@ describe("typespec-client-generator-core: package", () => { methodParam = method.parameters[1]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "contentType"); + strictEqual(methodParam.name, "contentType"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -1278,7 +1266,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.bodyParams.length, 1); const correspondingBodyParams = method.getParameterMapping(serviceOperation.bodyParams[0]); strictEqual(correspondingBodyParams.length, 1); - strictEqual(correspondingBodyParams[0].nameInClient, bodyParamProp.nameInClient); + strictEqual(correspondingBodyParams[0].name, bodyParamProp.name); const parameters = serviceOperation.parameters; strictEqual(parameters.length, 3); @@ -1287,17 +1275,17 @@ describe("typespec-client-generator-core: package", () => { strictEqual(headerParams.length, 2); let correspondingHeaderParams = method.getParameterMapping(headerParams[0]); strictEqual(correspondingHeaderParams.length, 1); - strictEqual(correspondingHeaderParams[0].nameInClient, headerParamProp.nameInClient); + strictEqual(correspondingHeaderParams[0].name, headerParamProp.name); correspondingHeaderParams = method.getParameterMapping(headerParams[1]); strictEqual(correspondingHeaderParams.length, 1); - strictEqual(correspondingHeaderParams[0].nameInClient, "contentType"); + strictEqual(correspondingHeaderParams[0].name, "contentType"); const queryParams = parameters.filter((x): x is SdkQueryParameter => x.kind === "query"); strictEqual(queryParams.length, 1); const correspondingQueryParams = method.getParameterMapping(queryParams[0]); strictEqual(correspondingQueryParams.length, 1); - strictEqual(correspondingQueryParams[0].nameInClient, queryParamProp.nameInClient); + strictEqual(correspondingQueryParams[0].name, queryParamProp.name); }); it("content type", async () => { @@ -1313,7 +1301,7 @@ describe("typespec-client-generator-core: package", () => { let methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "body"); + strictEqual(methodParam.name, "body"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -1321,7 +1309,7 @@ describe("typespec-client-generator-core: package", () => { methodParam = method.parameters[1]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "contentType"); + strictEqual(methodParam.name, "contentType"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -1334,12 +1322,12 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.bodyParams.length, 1); const correspondingBodyParams = method.getParameterMapping(serviceOperation.bodyParams[0]); strictEqual(correspondingBodyParams.length, 1); - strictEqual(correspondingBodyParams[0].nameInClient, "body"); + strictEqual(correspondingBodyParams[0].name, "body"); strictEqual(serviceOperation.parameters.length, 1); const correspondingHeaderParams = method.getParameterMapping(serviceOperation.parameters[0]); strictEqual(correspondingHeaderParams.length, 1); - strictEqual(correspondingHeaderParams[0].nameInClient, "contentType"); + strictEqual(correspondingHeaderParams[0].name, "contentType"); }); it("ensure content type is a constant if only one possibility", async () => { await runner.compileWithBuiltInService(` @@ -1353,11 +1341,11 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 2); const methodBodyParam = method.parameters[0]; - strictEqual(methodBodyParam.nameInClient, "body"); + strictEqual(methodBodyParam.name, "body"); strictEqual(methodBodyParam.type, sdkPackage.models[0]); const methodContentTypeParam = method.parameters[1]; - strictEqual(methodContentTypeParam.nameInClient, "contentType"); + strictEqual(methodContentTypeParam.name, "contentType"); const serviceOperation = method.operation; strictEqual(serviceOperation.bodyParams.length, 1); @@ -1370,7 +1358,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; - strictEqual(serviceContentTypeParam.nameInClient, "contentType"); + strictEqual(serviceContentTypeParam.name, "contentType"); strictEqual(serviceContentTypeParam.serializedName, "Content-Type"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); strictEqual(serviceContentTypeParam.type.kind, "constant"); @@ -1394,12 +1382,12 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 1); const methodAcceptParam = method.parameters[0]; - strictEqual(methodAcceptParam.nameInClient, "accept"); + strictEqual(methodAcceptParam.name, "accept"); const serviceOperation = method.operation; strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; - strictEqual(serviceContentTypeParam.nameInClient, "accept"); + strictEqual(serviceContentTypeParam.name, "accept"); strictEqual(serviceContentTypeParam.serializedName, "Accept"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); strictEqual(serviceContentTypeParam.type.kind, "constant"); @@ -1433,12 +1421,12 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 1); const methodAcceptParam = method.parameters[0]; - strictEqual(methodAcceptParam.nameInClient, "accept"); + strictEqual(methodAcceptParam.name, "accept"); const serviceOperation = method.operation; strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; - strictEqual(serviceContentTypeParam.nameInClient, "accept"); + strictEqual(serviceContentTypeParam.name, "accept"); strictEqual(serviceContentTypeParam.serializedName, "Accept"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); strictEqual(serviceContentTypeParam.type.kind, "constant"); @@ -1649,13 +1637,13 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 5); deepStrictEqual( - method.parameters.map((x) => x.nameInClient), + method.parameters.map((x) => x.name), ["id", "weight", "color", "contentType", "accept"] ); const bodyParameter = method.operation.bodyParams[0]; strictEqual(bodyParameter.kind, "body"); - strictEqual(bodyParameter.nameInClient, "body"); + strictEqual(bodyParameter.name, "body"); strictEqual(bodyParameter.onClient, false); strictEqual(bodyParameter.optional, false); strictEqual(bodyParameter.type.kind, "model"); @@ -1674,9 +1662,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(contentTypeOperationParam.onClient, false); strictEqual(contentTypeOperationParam.optional, false); - const contentTypeMethodParam = method.parameters.find( - (x) => x.nameInClient === "contentType" - )!; + const contentTypeMethodParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(contentTypeMethodParam.clientDefaultValue, undefined); strictEqual(contentTypeMethodParam.onClient, false); strictEqual(contentTypeMethodParam.optional, false); @@ -1689,7 +1675,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(acceptOperationParam.onClient, false); strictEqual(acceptOperationParam.optional, false); - const acceptMethodParam = method.parameters.find((x) => x.nameInClient === "accept")!; + const acceptMethodParam = method.parameters.find((x) => x.name === "accept")!; strictEqual(acceptMethodParam.clientDefaultValue, undefined); strictEqual(acceptMethodParam.onClient, false); strictEqual(acceptMethodParam.optional, false); @@ -1705,14 +1691,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.kind, "basic"); strictEqual(method.parameters.length, 2); - const methodIdParam = method.parameters.find((x) => x.nameInClient === "id")!; + const methodIdParam = method.parameters.find((x) => x.name === "id")!; strictEqual(methodIdParam.kind, "method"); strictEqual(methodIdParam.optional, false); strictEqual(methodIdParam.onClient, false); strictEqual(methodIdParam.isApiVersionParam, false); strictEqual(methodIdParam.type.kind, "string"); - const methodAcceptParam = method.parameters.find((x) => x.nameInClient === "accept")!; + const methodAcceptParam = method.parameters.find((x) => x.name === "accept")!; strictEqual(methodAcceptParam.clientDefaultValue, undefined); const serviceOperation = method.operation; @@ -1721,7 +1707,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); - strictEqual(pathParam.nameInClient, "id"); + strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); strictEqual(pathParam.isApiVersionParam, false); @@ -1736,7 +1722,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); - strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(pathParam.name, correspondingMethodParams[0].name); }); it("vanilla widget update", async () => { await compileVanillaWidgetService(runner, "@patch update(...Widget): Widget | Error;"); @@ -1749,7 +1735,7 @@ describe("typespec-client-generator-core: package", () => { const methodParamId = method.parameters[0]; strictEqual(methodParamId.kind, "method"); - strictEqual(methodParamId.nameInClient, "id"); + strictEqual(methodParamId.name, "id"); strictEqual(methodParamId.optional, false); strictEqual(methodParamId.onClient, false); strictEqual(methodParamId.isApiVersionParam, false); @@ -1757,7 +1743,7 @@ describe("typespec-client-generator-core: package", () => { const methodParamWeight = method.parameters[1]; strictEqual(methodParamWeight.kind, "method"); - strictEqual(methodParamWeight.nameInClient, "weight"); + strictEqual(methodParamWeight.name, "weight"); strictEqual(methodParamWeight.optional, false); strictEqual(methodParamWeight.onClient, false); strictEqual(methodParamWeight.isApiVersionParam, false); @@ -1765,19 +1751,17 @@ describe("typespec-client-generator-core: package", () => { const methodParamColor = method.parameters[2]; strictEqual(methodParamColor.kind, "method"); - strictEqual(methodParamColor.nameInClient, "color"); + strictEqual(methodParamColor.name, "color"); strictEqual(methodParamColor.optional, false); strictEqual(methodParamColor.onClient, false); strictEqual(methodParamColor.isApiVersionParam, false); strictEqual(methodParamColor.type.kind, "enum"); - const methodContentTypeParam = method.parameters.find( - (x) => x.nameInClient === "contentType" - )!; + const methodContentTypeParam = method.parameters.find((x) => x.name === "contentType")!; strictEqual(methodContentTypeParam.clientDefaultValue, undefined); strictEqual(methodContentTypeParam.optional, false); - const methodAcceptParam = method.parameters.find((x) => x.nameInClient === "accept")!; + const methodAcceptParam = method.parameters.find((x) => x.name === "accept")!; strictEqual(methodAcceptParam.clientDefaultValue, undefined); strictEqual(methodAcceptParam.optional, false); @@ -1786,7 +1770,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); - strictEqual(pathParam.nameInClient, "id"); + strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); strictEqual(pathParam.isApiVersionParam, false); @@ -1818,10 +1802,10 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method .getParameterMapping(bodyParameter) - .map((x) => x.nameInClient); + .map((x) => x.name); deepStrictEqual(correspondingMethodParams, ["weight", "color"]); deepStrictEqual( - bodyParameter.type.properties.map((p) => p.nameInClient), + bodyParameter.type.properties.map((p) => p.name), ["id", "weight", "color"] ); @@ -1839,7 +1823,7 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); - strictEqual(methodParam.nameInClient, "id"); + strictEqual(methodParam.name, "id"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); strictEqual(methodParam.isApiVersionParam, false); @@ -1850,7 +1834,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); - strictEqual(pathParam.nameInClient, "id"); + strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); strictEqual(pathParam.isApiVersionParam, false); @@ -1858,7 +1842,7 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); - strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); + strictEqual(pathParam.name, correspondingMethodParams[0].name); }); it("vanilla widget list", async () => { await compileVanillaWidgetService(runner, "@get list(): Widget[] | Error;"); @@ -2080,7 +2064,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 7); // TODO: what should we do with eTags and client request id? - const methodWidgetName = method.parameters.find((p) => p.nameInClient === "widgetName")!; + const methodWidgetName = method.parameters.find((p) => p.name === "widgetName")!; strictEqual(methodWidgetName.kind, "method"); strictEqual(methodWidgetName.isApiVersionParam, false); deepStrictEqual(methodWidgetName.apiVersions, ["2022-08-30"]); @@ -2091,7 +2075,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam = method.operation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); - strictEqual(pathParam.nameInClient, "widgetName"); + strictEqual(pathParam.name, "widgetName"); strictEqual(pathParam.serializedName, "widgetName"); strictEqual(pathParam.onClient, false); strictEqual(method.getParameterMapping(pathParam).length, 1); @@ -2099,7 +2083,7 @@ describe("typespec-client-generator-core: package", () => { const queryParam = method.operation.parameters.find((x) => x.kind === "query")!; strictEqual(queryParam.isApiVersionParam, true); - strictEqual(queryParam.nameInClient, "apiVersion"); + strictEqual(queryParam.name, "apiVersion"); strictEqual(queryParam.serializedName, "api-version"); strictEqual(queryParam.onClient, true); strictEqual(method.getParameterMapping(queryParam).length, 1); @@ -2108,7 +2092,7 @@ describe("typespec-client-generator-core: package", () => { parentClient.initialization!.properties.find((x) => x.isApiVersionParam) ); - const methodAcceptParam = method.parameters.find((x) => x.nameInClient === "accept")!; + const methodAcceptParam = method.parameters.find((x) => x.name === "accept")!; strictEqual(methodAcceptParam.clientDefaultValue, undefined); strictEqual(methodAcceptParam.onClient, false); strictEqual(methodAcceptParam.optional, false); @@ -2125,7 +2109,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.getParameterMapping(operationAcceptParam)[0], methodAcceptParam); strictEqual( - method.parameters.some((x) => x.nameInClient === "contentType"), + method.parameters.some((x) => x.name === "contentType"), false ); strictEqual( @@ -2162,21 +2146,21 @@ describe("typespec-client-generator-core: package", () => { strictEqual(getStatus.kind, "basic"); strictEqual(getStatus.parameters.length, 3); - const methodWidgetName = getStatus.parameters.find((p) => p.nameInClient === "widgetName")!; + const methodWidgetName = getStatus.parameters.find((p) => p.name === "widgetName")!; strictEqual(methodWidgetName.kind, "method"); strictEqual(methodWidgetName.isApiVersionParam, false); deepStrictEqual(methodWidgetName.apiVersions, ["2022-08-30"]); strictEqual(methodWidgetName.onClient, false); strictEqual(methodWidgetName.optional, false); - const methodOperationId = getStatus.parameters.find((p) => p.nameInClient === "operationId")!; + const methodOperationId = getStatus.parameters.find((p) => p.name === "operationId")!; strictEqual(methodOperationId.kind, "method"); strictEqual(methodOperationId.isApiVersionParam, false); deepStrictEqual(methodOperationId.apiVersions, ["2022-08-30"]); strictEqual(methodOperationId.onClient, false); strictEqual(methodOperationId.optional, false); - const methodAcceptParam = getStatus.parameters.find((x) => x.nameInClient === "accept")!; + const methodAcceptParam = getStatus.parameters.find((x) => x.name === "accept")!; strictEqual(methodAcceptParam.clientDefaultValue, undefined); strictEqual(methodAcceptParam.onClient, false); strictEqual(methodAcceptParam.optional, false); @@ -2188,7 +2172,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam1 = pathParams[0]; strictEqual(pathParam1.kind, "path"); - strictEqual(pathParam1.nameInClient, "widgetName"); + strictEqual(pathParam1.name, "widgetName"); strictEqual(pathParam1.serializedName, "widgetName"); strictEqual(pathParam1.onClient, false); strictEqual(getStatus.getParameterMapping(pathParam1).length, 1); @@ -2196,7 +2180,7 @@ describe("typespec-client-generator-core: package", () => { const pathParam2 = pathParams[1]; strictEqual(pathParam2.kind, "path"); - strictEqual(pathParam2.nameInClient, "operationId"); + strictEqual(pathParam2.name, "operationId"); strictEqual(pathParam2.serializedName, "operationId"); strictEqual(pathParam2.onClient, false); strictEqual(getStatus.getParameterMapping(pathParam2).length, 1); @@ -2204,7 +2188,7 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = getStatus.operation.parameters.find((x) => x.kind === "query")!; strictEqual(apiVersionParam.isApiVersionParam, true); - strictEqual(apiVersionParam.nameInClient, "apiVersion"); + strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.serializedName, "api-version"); strictEqual(apiVersionParam.onClient, true); strictEqual(getStatus.getParameterMapping(apiVersionParam).length, 1); @@ -2214,7 +2198,7 @@ describe("typespec-client-generator-core: package", () => { ); const operationAcceptParam = getStatus.operation.parameters.find((x) => x.kind === "header")!; - strictEqual(operationAcceptParam.nameInClient, "accept"); + strictEqual(operationAcceptParam.name, "accept"); strictEqual(operationAcceptParam.clientDefaultValue, undefined); strictEqual(operationAcceptParam.onClient, false); strictEqual(operationAcceptParam.optional, false); @@ -2226,11 +2210,11 @@ describe("typespec-client-generator-core: package", () => { const createOrUpdate = client.methods.find((x) => x.name === "createOrUpdateWidget")!; strictEqual(createOrUpdate.kind, "lro"); strictEqual( - createOrUpdate.parameters.find((x) => x.nameInClient === "apiVersion"), + createOrUpdate.parameters.find((x) => x.name === "apiVersion"), undefined ); deepStrictEqual( - createOrUpdate.parameters.map((x) => x.nameInClient), + createOrUpdate.parameters.map((x) => x.name), [ "widgetName", "contentType", @@ -2252,7 +2236,7 @@ describe("typespec-client-generator-core: package", () => { (x): x is SdkHeaderParameter => x.kind === "header" ); deepStrictEqual( - headerParams.map((x) => x.nameInClient), + headerParams.map((x) => x.name), [ "contentType", "repeatabilityRequestId", @@ -2275,7 +2259,7 @@ describe("typespec-client-generator-core: package", () => { "api-version" ); strictEqual(serviceOperation.bodyParams.length, 1); - strictEqual(serviceOperation.bodyParams[0].nameInClient, "resource"); + strictEqual(serviceOperation.bodyParams[0].name, "resource"); strictEqual(serviceOperation.bodyParams[0].type, widgetModel); strictEqual(Object.keys(serviceOperation.responses).length, 2); @@ -2345,7 +2329,7 @@ describe("typespec-client-generator-core: package", () => { strictEqual(listManufacturers.kind, "paging"); strictEqual(listManufacturers.parameters.length, 2); deepStrictEqual( - listManufacturers.parameters.map((x) => x.nameInClient), + listManufacturers.parameters.map((x) => x.name), ["clientRequestId", "accept"] ); const methodResponse = listManufacturers.response.type!; @@ -2359,20 +2343,18 @@ describe("typespec-client-generator-core: package", () => { const apiVersion = operation.parameters.find((x) => x.isApiVersionParam)!; strictEqual(apiVersion.kind, "query"); - strictEqual(apiVersion.nameInClient, "apiVersion"); + strictEqual(apiVersion.name, "apiVersion"); strictEqual(apiVersion.serializedName, "api-version"); strictEqual(apiVersion.onClient, true); - const clientRequestId = operation.parameters.find( - (x) => x.nameInClient === "clientRequestId" - )!; + const clientRequestId = operation.parameters.find((x) => x.name === "clientRequestId")!; strictEqual(clientRequestId.kind, "header"); deepStrictEqual( listManufacturers.getParameterMapping(clientRequestId)[0], listManufacturers.parameters[0] ); - const accept = operation.parameters.find((x) => x.nameInClient === "accept")!; + const accept = operation.parameters.find((x) => x.name === "accept")!; strictEqual(accept.kind, "header"); deepStrictEqual( listManufacturers.getParameterMapping(accept)[0], @@ -2387,19 +2369,19 @@ describe("typespec-client-generator-core: package", () => { strictEqual(pagingModel.name, "PagedManufacturer"); strictEqual(pagingModel.properties.length, 3); - const valueProperty = pagingModel.properties.find((x) => x.nameInClient === "value")!; + const valueProperty = pagingModel.properties.find((x) => x.name === "value")!; strictEqual(valueProperty.kind, "property"); strictEqual(valueProperty.type.kind, "array"); strictEqual(valueProperty.type.valueType, sdkPackage.models[0]); - const nextLinkProperty = pagingModel.properties.find((x) => x.nameInClient === "nextLink")!; + const nextLinkProperty = pagingModel.properties.find((x) => x.name === "nextLink")!; strictEqual(nextLinkProperty.kind, "property"); strictEqual(nextLinkProperty.type.kind, "url"); strictEqual(nextLinkProperty.serializedName, "nextLink"); strictEqual(nextLinkProperty.serializedName, listManufacturers.nextLinkPath); const clientRequestIdProperty = pagingModel.properties.find( - (x) => x.nameInClient === "clientRequestId" + (x) => x.name === "clientRequestId" )!; strictEqual(clientRequestIdProperty.kind, "header"); }); diff --git a/packages/typespec-client-generator-core/test/types.test.ts b/packages/typespec-client-generator-core/test/types.test.ts index b367b6f2de..bc4b820139 100644 --- a/packages/typespec-client-generator-core/test/types.test.ts +++ b/packages/typespec-client-generator-core/test/types.test.ts @@ -208,7 +208,7 @@ describe("typespec-client-generator-core: types", () => { (x) => x.kind === "model" && x.name === "User" )! as SdkModelType; strictEqual(userModel.properties.length, 2); - const etagProperty = userModel.properties.find((x) => x.nameInClient === "etag")!; + const etagProperty = userModel.properties.find((x) => x.name === "etag")!; strictEqual(etagProperty.type.kind, "eTag"); }); @@ -261,9 +261,9 @@ describe("typespec-client-generator-core: types", () => { strictEqual(e2.kind, "enum"); strictEqual(e2.valueType.kind, "string"); for (const property of (m as SdkModelType).properties) { - if (property.nameInClient === "prop1") { + if (property.name === "prop1") { strictEqual(property.type, e2); - } else if (property.nameInClient === "prop2") { + } else if (property.name === "prop2") { strictEqual(property.type, e1); } } @@ -1267,15 +1267,13 @@ describe("typespec-client-generator-core: types", () => { strictEqual(sdkModel.name, "JavaTest"); // Java projected name test - const javaProjectedProp = sdkModel.properties.find( - (x) => x.nameInClient === "javaProjectedName" - )!; + const javaProjectedProp = sdkModel.properties.find((x) => x.name === "javaProjectedName")!; strictEqual(javaProjectedProp.kind, "property"); strictEqual(javaProjectedProp.serializedName, "javaWireName"); // client projected name test - const clientProjectedProp = sdkModel.properties.find((x) => x.nameInClient === "clientName")!; + const clientProjectedProp = sdkModel.properties.find((x) => x.name === "clientName")!; strictEqual(clientProjectedProp.kind, "property"); strictEqual(clientProjectedProp.serializedName, "clientProjectedName"); @@ -1283,19 +1281,19 @@ describe("typespec-client-generator-core: types", () => { const jsonEncodedProp = sdkModel.properties.find( (x) => x.kind === "property" && x.serializedName === "encodedWireName" )!; - 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" )!; - strictEqual(jsonProjectedProp.nameInClient, "jsonProjectedName"); + strictEqual(jsonProjectedProp.name, "jsonProjectedName"); // regular const regularProp = sdkModel.properties.find( (x) => x.kind === "property" && x.serializedName === "regular" )!; - strictEqual(regularProp.nameInClient, "regular"); + strictEqual(regularProp.name, "regular"); }); it("union type", async function () { await runner.compileWithBuiltInService(` @@ -1533,7 +1531,7 @@ describe("typespec-client-generator-core: 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"); }); @@ -1573,7 +1571,7 @@ describe("typespec-client-generator-core: types", () => { strictEqual(models.length, 5); const fish = models.find((x) => x.name === "Fish")! as SdkModelType; const kindProperty = fish.properties.find( - (x) => x.nameInClient === "kind" + (x) => x.name === "kind" )! as SdkBodyModelPropertyType; strictEqual(kindProperty.discriminator, true); strictEqual(kindProperty.type.kind, "string"); @@ -1582,7 +1580,7 @@ describe("typespec-client-generator-core: types", () => { const shark = models.find((x) => x.name === "Shark")! as SdkModelType; strictEqual(shark.properties.length, 2); const sharktypeProperty = shark.properties.find( - (x) => x.nameInClient === "sharktype" + (x) => x.name === "sharktype" )! as SdkBodyModelPropertyType; strictEqual(sharktypeProperty.discriminator, true); strictEqual(sharktypeProperty.type.kind, "string"); @@ -1603,7 +1601,7 @@ describe("typespec-client-generator-core: types", () => { strictEqual(models.length, 1); const fish = models.find((x) => x.name === "Fish")! as SdkModelType; const kindProperty = fish.properties.find( - (x) => x.nameInClient === "kind" + (x) => x.name === "kind" )! as SdkBodyModelPropertyType; strictEqual(kindProperty.discriminator, true); strictEqual(kindProperty.type.kind, "string"); @@ -1735,7 +1733,7 @@ describe("typespec-client-generator-core: types", () => { const kind = enums.find((x) => x.name === "")!; strictEqual(kind.generatedName, "PetKind"); const kindProperty = pet.properties.find( - (x) => (x.nameInClient = "kind") + (x) => (x.name = "kind") )! as SdkBodyModelPropertyType; strictEqual(kindProperty.type, kind); }); @@ -1815,7 +1813,7 @@ describe("typespec-client-generator-core: types", () => { const shark = models.find((x) => x.name === "Shark")! as SdkModelType; strictEqual(shark.properties.length, 2); const sharktypeProperty = shark.properties.find( - (x) => x.nameInClient === "sharktype" + (x) => x.name === "sharktype" )! as SdkBodyModelPropertyType; strictEqual(sharktypeProperty.discriminator, true); strictEqual(sharktypeProperty.type.kind, "string"); @@ -1850,15 +1848,15 @@ describe("typespec-client-generator-core: types", () => { const models = runner.context.experimental_sdkPackage.models; strictEqual(models.length, 3); const fish = models.find((x) => x.name === "Fish")!; - let kindTypeProperty = fish.properties.find((x) => x.nameInClient === "kind")!; + let kindTypeProperty = fish.properties.find((x) => x.name === "kind")!; strictEqual(kindTypeProperty.type.kind, "enum"); strictEqual(fish.discriminatorProperty, kindTypeProperty); const shark = models.find((x) => x.name === "Shark")!; strictEqual(shark.discriminatorValue, "shark"); - kindTypeProperty = shark.properties.find((x) => x.nameInClient === "kind")!; + kindTypeProperty = shark.properties.find((x) => x.name === "kind")!; strictEqual(kindTypeProperty.type.kind, "enumvalue"); const salmon = models.find((x) => x.name === "Salmon")!; - kindTypeProperty = salmon.properties.find((x) => x.nameInClient === "kind")!; + kindTypeProperty = salmon.properties.find((x) => x.name === "kind")!; strictEqual(kindTypeProperty.type.kind, "enumvalue"); strictEqual(salmon.discriminatorValue, "salmon"); @@ -2121,7 +2119,7 @@ describe("typespec-client-generator-core: types", () => { const propreties: string[] = []; models.forEach((model) => { (model as SdkModelType).properties.forEach((prop) => { - propreties.push(prop.nameInClient); + propreties.push(prop.name); }); }); propreties.sort(); @@ -2496,10 +2494,10 @@ describe("typespec-client-generator-core: types", () => { strictEqual(model.isFormDataType, true); strictEqual(model.name, "MultiPartRequest"); strictEqual(model.properties.length, 2); - const id = model.properties.find((x) => x.nameInClient === "id")!; + const id = model.properties.find((x) => x.name === "id")!; strictEqual(id.kind, "property"); strictEqual(id.type.kind, "string"); - const profileImage = model.properties.find((x) => x.nameInClient === "profileImage")!; + const profileImage = model.properties.find((x) => x.name === "profileImage")!; strictEqual(profileImage.kind, "property"); strictEqual(profileImage.isMultipartFileInput, true); }); @@ -2656,14 +2654,14 @@ describe("typespec-client-generator-core: types", () => { const models = runner.context.experimental_sdkPackage.models; strictEqual(models.length, 1); const scopes = (models[0] as SdkModelType).properties.find( - (x) => x.nameInClient === "scopes" + (x) => x.name === "scopes" )! as SdkBodyModelPropertyType; strictEqual(scopes.type.kind, "tuple"); strictEqual(scopes.type.values[0].kind, "constant"); strictEqual(scopes.type.values[0].valueType.kind, "string"); strictEqual(scopes.type.values[0].value, "https://security.microsoft.com/.default"); const test = (models[0] as SdkModelType).properties.find( - (x) => x.nameInClient === "test" + (x) => x.name === "test" )! as SdkBodyModelPropertyType; strictEqual(test.type.kind, "tuple"); strictEqual(test.type.values[0].kind, "int32"); From c5b5a7f6dc869600a8a82cac466a8f6c8d6de123 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Tue, 19 Mar 2024 15:02:12 -0400 Subject: [PATCH 2/4] add changeset --- .chronus/changes/name_in_client-2024-2-19-15-2-6.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .chronus/changes/name_in_client-2024-2-19-15-2-6.md diff --git a/.chronus/changes/name_in_client-2024-2-19-15-2-6.md b/.chronus/changes/name_in_client-2024-2-19-15-2-6.md new file mode 100644 index 0000000000..82315b08fd --- /dev/null +++ b/.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 \ No newline at end of file From 28b687bf70cc7705d7d288f50bf262695e003342 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Tue, 19 Mar 2024 15:12:33 -0400 Subject: [PATCH 3/4] add issue link for deprecation removal --- packages/typespec-client-generator-core/src/interfaces.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts index de1297938c..7712475eeb 100644 --- a/packages/typespec-client-generator-core/src/interfaces.ts +++ b/packages/typespec-client-generator-core/src/interfaces.ts @@ -289,7 +289,8 @@ export interface SdkModelPropertyTypeBase { __raw?: ModelProperty; type: SdkType; /** - * @deprecated This property is deprecated. Use `.name` instead + * @deprecated This property is deprecated. Use `.name` instead. + * https://github.com/Azure/typespec-azure/issues/446 */ nameInClient: string; name: string; From b1690fe3821abb6a46f8a8bf8a5aca89460e1711 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Tue, 19 Mar 2024 16:20:19 -0400 Subject: [PATCH 4/4] add back nameInClient tests --- .../test/package.test.ts | 157 ++++++++++++++++++ .../test/types.test.ts | 8 + 2 files changed, 165 insertions(+) diff --git a/packages/typespec-client-generator-core/test/package.test.ts b/packages/typespec-client-generator-core/test/package.test.ts index a6fcd5d942..66579449f1 100644 --- a/packages/typespec-client-generator-core/test/package.test.ts +++ b/packages/typespec-client-generator-core/test/package.test.ts @@ -97,6 +97,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(initialization.properties.length, 1); const endpointParam = initialization.properties[0]; strictEqual(endpointParam.kind, "endpoint"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(endpointParam.nameInClient, "endpoint"); strictEqual(endpointParam.name, "endpoint"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); @@ -129,6 +131,8 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(credentialParam.nameInClient, "credential"); strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); @@ -168,6 +172,8 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(credentialParam.nameInClient, "credential"); strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); @@ -213,6 +219,8 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(credentialParam.nameInClient, "credential"); strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); @@ -268,6 +276,8 @@ describe("typespec-client-generator-core: package", () => { )[0]; strictEqual(endpointParam.clientDefaultValue, undefined); strictEqual(endpointParam.urlEncode, false); + //eslint-disable-next-line deprecation/deprecation + strictEqual(endpointParam.nameInClient, "endpointInput"); strictEqual(endpointParam.name, "endpointInput"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); @@ -277,6 +287,8 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(credentialParam.nameInClient, "credential"); strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); @@ -327,6 +339,8 @@ describe("typespec-client-generator-core: package", () => { const endpointParam = endpointParams[0]; strictEqual(endpointParam.clientDefaultValue, undefined); strictEqual(endpointParam.urlEncode, false); + //eslint-disable-next-line deprecation/deprecation + strictEqual(endpointParam.nameInClient, "endpoint"); strictEqual(endpointParam.name, "endpoint"); strictEqual(endpointParam.onClient, true); strictEqual(endpointParam.optional, false); @@ -335,6 +349,8 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = endpointParams[1]; strictEqual(apiVersionParam.clientDefaultValue, "v1.0"); strictEqual(apiVersionParam.urlEncode, false); + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersionParam.nameInClient, "apiVersion"); strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); @@ -344,6 +360,8 @@ describe("typespec-client-generator-core: package", () => { const credentialParam = initialization.properties.filter( (p): p is SdkCredentialParameter => p.kind === "credential" )[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(credentialParam.nameInClient, "credential"); strictEqual(credentialParam.name, "credential"); strictEqual(credentialParam.onClient, true); strictEqual(credentialParam.optional, false); @@ -403,6 +421,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(client.apiVersions[0], "2022-12-01-preview"); const apiVersionParam = initialization.properties.filter((p) => p.isApiVersionParam)[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersionParam.nameInClient, "apiVersion"); strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); @@ -463,6 +483,8 @@ describe("typespec-client-generator-core: package", () => { deepStrictEqual(client.apiVersions, ["2022-12-01-preview", "2022-12-01"]); const apiVersionParam = initialization.properties.filter((p) => p.isApiVersionParam)[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersionParam.nameInClient, "apiVersion"); strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.onClient, true); strictEqual(apiVersionParam.optional, false); @@ -511,6 +533,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(mainClient.methods.length, 1); strictEqual(mainClient.initialization!.properties.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(mainClient.initialization!.properties[0].nameInClient, "endpoint"); strictEqual(mainClient.initialization!.properties[0].name, "endpoint"); const clientAccessor = mainClient.methods[0]; @@ -547,6 +571,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(mainClient.methods.length, 2); strictEqual(mainClient.initialization!.properties.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(mainClient.initialization!.properties[0].nameInClient, "endpoint"); strictEqual(mainClient.initialization!.properties[0].name, "endpoint"); const fooAccessor = mainClient.methods[0]; @@ -616,6 +642,8 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); strictEqual(client.initialization.properties[0].name, "endpoint"); strictEqual(client.methods.length, 1); @@ -645,8 +673,12 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); + //eslint-disable-next-line deprecation/deprecation + strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); @@ -719,6 +751,8 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); strictEqual(client.initialization.properties[0].name, "endpoint"); const withoutApiVersion = client.methods[0]; @@ -745,9 +779,13 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); + //eslint-disable-next-line deprecation/deprecation + strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); @@ -790,9 +828,13 @@ describe("typespec-client-generator-core: package", () => { const client = sdkPackage.clients[0]; strictEqual(client.initialization?.properties.length, 2); + //eslint-disable-next-line deprecation/deprecation + strictEqual(client.initialization.properties[0].nameInClient, "endpoint"); strictEqual(client.initialization.properties[0].name, "endpoint"); const clientApiVersionParam = client.initialization.properties[1]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(clientApiVersionParam.nameInClient, "apiVersion"); strictEqual(clientApiVersionParam.name, "apiVersion"); strictEqual(clientApiVersionParam.onClient, true); strictEqual(clientApiVersionParam.optional, false); @@ -811,6 +853,8 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = withApiVersion.operation.parameters[0]; strictEqual(apiVersionParam.kind, "path"); strictEqual(apiVersionParam.serializedName, "apiVersion"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersionParam.nameInClient, "apiVersion"); strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.isApiVersionParam, true); strictEqual(apiVersionParam.optional, false); @@ -835,6 +879,8 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "path"); strictEqual(methodParam.name, "path"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -850,6 +896,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "path"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, "path"); strictEqual(pathParam.name, "path"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); @@ -861,6 +909,8 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(pathParam.name, correspondingMethodParams[0].name); }); @@ -879,6 +929,8 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "header"); strictEqual(methodParam.name, "header"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -894,6 +946,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(headerParam.kind, "header"); strictEqual(headerParam.serializedName, "header"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(headerParam.nameInClient, "header"); strictEqual(headerParam.name, "header"); strictEqual(headerParam.optional, false); strictEqual(headerParam.onClient, false); @@ -903,6 +957,8 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(headerParam); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(headerParam.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(headerParam.name, correspondingMethodParams[0].name); }); @@ -938,6 +994,8 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "query"); strictEqual(methodParam.name, "query"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -952,6 +1010,8 @@ describe("typespec-client-generator-core: package", () => { const queryParam = serviceOperation.parameters[0]; strictEqual(queryParam.kind, "query"); strictEqual(queryParam.serializedName, "query"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(queryParam.nameInClient, "query"); strictEqual(queryParam.name, "query"); strictEqual(queryParam.optional, false); strictEqual(queryParam.onClient, false); @@ -961,6 +1021,8 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(queryParam); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(queryParam.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(queryParam.name, correspondingMethodParams[0].name); }); @@ -1025,10 +1087,14 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(bodyParameter.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(bodyParameter.name, correspondingMethodParams[0].name); strictEqual(serviceOperation.parameters.length, 1); const contentTypeParam = serviceOperation.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(contentTypeParam.nameInClient, "contentType"); strictEqual(contentTypeParam.name, "contentType"); strictEqual(contentTypeParam.serializedName, "Content-Type"); strictEqual(contentTypeParam.clientDefaultValue, undefined); @@ -1084,10 +1150,14 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(bodyParameter.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(bodyParameter.name, correspondingMethodParams[0].name); strictEqual(serviceOperation.parameters.length, 1); const contentTypeParam = serviceOperation.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(contentTypeParam.nameInClient, "contentType"); strictEqual(contentTypeParam.name, "contentType"); strictEqual(contentTypeParam.serializedName, "Content-Type"); strictEqual(contentTypeParam.clientDefaultValue, undefined); @@ -1140,6 +1210,10 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); + strictEqual( + bodyParameter.type.properties[0].nameInClient, //eslint-disable-line deprecation/deprecation + correspondingMethodParams[0].nameInClient //eslint-disable-line deprecation/deprecation + ); strictEqual(bodyParameter.type.properties[0].name, correspondingMethodParams[0].name); }); @@ -1182,10 +1256,17 @@ describe("typespec-client-generator-core: package", () => { strictEqual(bodyParameter.optional, false); strictEqual(bodyParameter.type.kind, "model"); strictEqual(bodyParameter.type.properties.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(bodyParameter.type.properties[0].nameInClient, "name"); strictEqual(bodyParameter.type.properties[0].name, "name"); const correspondingMethodParams = method.getParameterMapping(bodyParameter); strictEqual(correspondingMethodParams.length, 1); + + strictEqual( + bodyParameter.type.properties[0].nameInClient, //eslint-disable-line deprecation/deprecation + correspondingMethodParams[0].nameInClient //eslint-disable-line deprecation/deprecation + ); strictEqual(bodyParameter.type.properties[0].name, correspondingMethodParams[0].name); }); @@ -1213,6 +1294,8 @@ describe("typespec-client-generator-core: package", () => { let methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "options"); strictEqual(methodParam.name, "options"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -1227,6 +1310,8 @@ describe("typespec-client-generator-core: package", () => { (x): x is SdkHeaderParameter => x.name === "header" )!; strictEqual(headerParamProp.kind, "header"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(headerParamProp.nameInClient, "header"); strictEqual(headerParamProp.name, "header"); strictEqual(headerParamProp.optional, false); strictEqual(headerParamProp.onClient, false); @@ -1236,6 +1321,8 @@ describe("typespec-client-generator-core: package", () => { (x): x is SdkQueryParameter => x.name === "query" )!; strictEqual(queryParamProp.kind, "query"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(queryParamProp.nameInClient, "query"); strictEqual(queryParamProp.name, "query"); strictEqual(queryParamProp.optional, false); strictEqual(queryParamProp.onClient, false); @@ -1245,6 +1332,8 @@ describe("typespec-client-generator-core: package", () => { (x): x is SdkBodyParameter => x.name === "body" )!; strictEqual(bodyParamProp.kind, "body"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(bodyParamProp.nameInClient, "body"); strictEqual(bodyParamProp.name, "body"); strictEqual(bodyParamProp.optional, false); strictEqual(bodyParamProp.onClient, false); @@ -1254,6 +1343,8 @@ describe("typespec-client-generator-core: package", () => { methodParam = method.parameters[1]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "contentType"); strictEqual(methodParam.name, "contentType"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -1266,6 +1357,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.bodyParams.length, 1); const correspondingBodyParams = method.getParameterMapping(serviceOperation.bodyParams[0]); strictEqual(correspondingBodyParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingBodyParams[0].nameInClient, bodyParamProp.nameInClient); strictEqual(correspondingBodyParams[0].name, bodyParamProp.name); const parameters = serviceOperation.parameters; @@ -1275,16 +1368,22 @@ describe("typespec-client-generator-core: package", () => { strictEqual(headerParams.length, 2); let correspondingHeaderParams = method.getParameterMapping(headerParams[0]); strictEqual(correspondingHeaderParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingHeaderParams[0].nameInClient, headerParamProp.nameInClient); strictEqual(correspondingHeaderParams[0].name, headerParamProp.name); correspondingHeaderParams = method.getParameterMapping(headerParams[1]); strictEqual(correspondingHeaderParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingHeaderParams[0].nameInClient, "contentType"); strictEqual(correspondingHeaderParams[0].name, "contentType"); const queryParams = parameters.filter((x): x is SdkQueryParameter => x.kind === "query"); strictEqual(queryParams.length, 1); const correspondingQueryParams = method.getParameterMapping(queryParams[0]); strictEqual(correspondingQueryParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingQueryParams[0].nameInClient, queryParamProp.nameInClient); strictEqual(correspondingQueryParams[0].name, queryParamProp.name); }); @@ -1301,6 +1400,8 @@ describe("typespec-client-generator-core: package", () => { let methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "body"); strictEqual(methodParam.name, "body"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -1309,6 +1410,8 @@ describe("typespec-client-generator-core: package", () => { methodParam = method.parameters[1]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "contentType"); strictEqual(methodParam.name, "contentType"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -1322,11 +1425,15 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.bodyParams.length, 1); const correspondingBodyParams = method.getParameterMapping(serviceOperation.bodyParams[0]); strictEqual(correspondingBodyParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingBodyParams[0].nameInClient, "body"); strictEqual(correspondingBodyParams[0].name, "body"); strictEqual(serviceOperation.parameters.length, 1); const correspondingHeaderParams = method.getParameterMapping(serviceOperation.parameters[0]); strictEqual(correspondingHeaderParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(correspondingHeaderParams[0].nameInClient, "contentType"); strictEqual(correspondingHeaderParams[0].name, "contentType"); }); it("ensure content type is a constant if only one possibility", async () => { @@ -1341,10 +1448,14 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 2); const methodBodyParam = method.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodBodyParam.nameInClient, "body"); strictEqual(methodBodyParam.name, "body"); strictEqual(methodBodyParam.type, sdkPackage.models[0]); const methodContentTypeParam = method.parameters[1]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodContentTypeParam.nameInClient, "contentType"); strictEqual(methodContentTypeParam.name, "contentType"); const serviceOperation = method.operation; @@ -1358,6 +1469,8 @@ describe("typespec-client-generator-core: package", () => { strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(serviceContentTypeParam.nameInClient, "contentType"); strictEqual(serviceContentTypeParam.name, "contentType"); strictEqual(serviceContentTypeParam.serializedName, "Content-Type"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); @@ -1382,11 +1495,15 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 1); const methodAcceptParam = method.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodAcceptParam.nameInClient, "accept"); strictEqual(methodAcceptParam.name, "accept"); const serviceOperation = method.operation; strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(serviceContentTypeParam.nameInClient, "accept"); strictEqual(serviceContentTypeParam.name, "accept"); strictEqual(serviceContentTypeParam.serializedName, "Accept"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); @@ -1421,11 +1538,15 @@ describe("typespec-client-generator-core: package", () => { strictEqual(method.parameters.length, 1); const methodAcceptParam = method.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodAcceptParam.nameInClient, "accept"); strictEqual(methodAcceptParam.name, "accept"); const serviceOperation = method.operation; strictEqual(serviceOperation.parameters.length, 1); const serviceContentTypeParam = serviceOperation.parameters[0]; + //eslint-disable-next-line deprecation/deprecation + strictEqual(serviceContentTypeParam.nameInClient, "accept"); strictEqual(serviceContentTypeParam.name, "accept"); strictEqual(serviceContentTypeParam.serializedName, "Accept"); strictEqual(serviceContentTypeParam.clientDefaultValue, undefined); @@ -1643,6 +1764,8 @@ describe("typespec-client-generator-core: package", () => { const bodyParameter = method.operation.bodyParams[0]; strictEqual(bodyParameter.kind, "body"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(bodyParameter.nameInClient, "body"); strictEqual(bodyParameter.name, "body"); strictEqual(bodyParameter.onClient, false); strictEqual(bodyParameter.optional, false); @@ -1707,6 +1830,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, "id"); strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); @@ -1722,6 +1847,8 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(pathParam.name, correspondingMethodParams[0].name); }); it("vanilla widget update", async () => { @@ -1735,6 +1862,8 @@ describe("typespec-client-generator-core: package", () => { const methodParamId = method.parameters[0]; strictEqual(methodParamId.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParamId.nameInClient, "id"); strictEqual(methodParamId.name, "id"); strictEqual(methodParamId.optional, false); strictEqual(methodParamId.onClient, false); @@ -1743,6 +1872,8 @@ describe("typespec-client-generator-core: package", () => { const methodParamWeight = method.parameters[1]; strictEqual(methodParamWeight.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParamWeight.nameInClient, "weight"); strictEqual(methodParamWeight.name, "weight"); strictEqual(methodParamWeight.optional, false); strictEqual(methodParamWeight.onClient, false); @@ -1751,6 +1882,8 @@ describe("typespec-client-generator-core: package", () => { const methodParamColor = method.parameters[2]; strictEqual(methodParamColor.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParamColor.nameInClient, "color"); strictEqual(methodParamColor.name, "color"); strictEqual(methodParamColor.optional, false); strictEqual(methodParamColor.onClient, false); @@ -1770,6 +1903,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, "id"); strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); @@ -1823,6 +1958,8 @@ describe("typespec-client-generator-core: package", () => { const methodParam = method.parameters[0]; strictEqual(methodParam.kind, "method"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(methodParam.nameInClient, "id"); strictEqual(methodParam.name, "id"); strictEqual(methodParam.optional, false); strictEqual(methodParam.onClient, false); @@ -1834,6 +1971,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam = serviceOperation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); strictEqual(pathParam.serializedName, "id"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, "id"); strictEqual(pathParam.name, "id"); strictEqual(pathParam.optional, false); strictEqual(pathParam.onClient, false); @@ -1842,6 +1981,8 @@ describe("typespec-client-generator-core: package", () => { const correspondingMethodParams = method.getParameterMapping(pathParam); strictEqual(correspondingMethodParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, correspondingMethodParams[0].nameInClient); strictEqual(pathParam.name, correspondingMethodParams[0].name); }); it("vanilla widget list", async () => { @@ -2075,6 +2216,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam = method.operation.parameters.find((x) => x.kind === "path")!; strictEqual(pathParam.kind, "path"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam.nameInClient, "widgetName"); strictEqual(pathParam.name, "widgetName"); strictEqual(pathParam.serializedName, "widgetName"); strictEqual(pathParam.onClient, false); @@ -2083,6 +2226,8 @@ describe("typespec-client-generator-core: package", () => { const queryParam = method.operation.parameters.find((x) => x.kind === "query")!; strictEqual(queryParam.isApiVersionParam, true); + //eslint-disable-next-line deprecation/deprecation + strictEqual(queryParam.nameInClient, "apiVersion"); strictEqual(queryParam.name, "apiVersion"); strictEqual(queryParam.serializedName, "api-version"); strictEqual(queryParam.onClient, true); @@ -2172,6 +2317,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam1 = pathParams[0]; strictEqual(pathParam1.kind, "path"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam1.nameInClient, "widgetName"); strictEqual(pathParam1.name, "widgetName"); strictEqual(pathParam1.serializedName, "widgetName"); strictEqual(pathParam1.onClient, false); @@ -2180,6 +2327,8 @@ describe("typespec-client-generator-core: package", () => { const pathParam2 = pathParams[1]; strictEqual(pathParam2.kind, "path"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(pathParam2.nameInClient, "operationId"); strictEqual(pathParam2.name, "operationId"); strictEqual(pathParam2.serializedName, "operationId"); strictEqual(pathParam2.onClient, false); @@ -2188,6 +2337,8 @@ describe("typespec-client-generator-core: package", () => { const apiVersionParam = getStatus.operation.parameters.find((x) => x.kind === "query")!; strictEqual(apiVersionParam.isApiVersionParam, true); + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersionParam.nameInClient, "apiVersion"); strictEqual(apiVersionParam.name, "apiVersion"); strictEqual(apiVersionParam.serializedName, "api-version"); strictEqual(apiVersionParam.onClient, true); @@ -2198,6 +2349,8 @@ describe("typespec-client-generator-core: package", () => { ); const operationAcceptParam = getStatus.operation.parameters.find((x) => x.kind === "header")!; + //eslint-disable-next-line deprecation/deprecation + strictEqual(operationAcceptParam.nameInClient, "accept"); strictEqual(operationAcceptParam.name, "accept"); strictEqual(operationAcceptParam.clientDefaultValue, undefined); strictEqual(operationAcceptParam.onClient, false); @@ -2259,6 +2412,8 @@ describe("typespec-client-generator-core: package", () => { "api-version" ); strictEqual(serviceOperation.bodyParams.length, 1); + //eslint-disable-next-line deprecation/deprecation + strictEqual(serviceOperation.bodyParams[0].nameInClient, "resource"); strictEqual(serviceOperation.bodyParams[0].name, "resource"); strictEqual(serviceOperation.bodyParams[0].type, widgetModel); @@ -2343,6 +2498,8 @@ describe("typespec-client-generator-core: package", () => { const apiVersion = operation.parameters.find((x) => x.isApiVersionParam)!; strictEqual(apiVersion.kind, "query"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(apiVersion.nameInClient, "apiVersion"); strictEqual(apiVersion.name, "apiVersion"); strictEqual(apiVersion.serializedName, "api-version"); strictEqual(apiVersion.onClient, true); diff --git a/packages/typespec-client-generator-core/test/types.test.ts b/packages/typespec-client-generator-core/test/types.test.ts index bc4b820139..b764c2c441 100644 --- a/packages/typespec-client-generator-core/test/types.test.ts +++ b/packages/typespec-client-generator-core/test/types.test.ts @@ -1281,18 +1281,24 @@ describe("typespec-client-generator-core: types", () => { const jsonEncodedProp = sdkModel.properties.find( (x) => x.kind === "property" && x.serializedName === "encodedWireName" )!; + //eslint-disable-next-line deprecation/deprecation + 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" )!; + //eslint-disable-next-line deprecation/deprecation + strictEqual(jsonProjectedProp.nameInClient, "jsonProjectedName"); strictEqual(jsonProjectedProp.name, "jsonProjectedName"); // regular const regularProp = sdkModel.properties.find( (x) => x.kind === "property" && x.serializedName === "regular" )!; + //eslint-disable-next-line deprecation/deprecation + strictEqual(regularProp.nameInClient, "regular"); strictEqual(regularProp.name, "regular"); }); it("union type", async function () { @@ -1531,6 +1537,8 @@ describe("typespec-client-generator-core: types", () => { strictEqual(recursiveModel.properties.length, 1); const prop = recursiveModel.properties[0]; strictEqual(prop.kind, "property"); + //eslint-disable-next-line deprecation/deprecation + strictEqual(prop.nameInClient, "prop"); strictEqual(prop.name, "prop"); strictEqual(prop.type.kind, "model"); strictEqual(prop.type.name, "RecursiveModel");