[tcgc] rollback SdkApiVersionParameter and remove some deprecations (#2421)

1. since we could not use `SdkApiVersionParameter` in endpoint template
arguments, we decided to rollback to previous logic of
`isApiVersionParam`.
2. clean up some deprecations that emitter has already finished the
migration.

Author: tadelesh

.chronus/changes/tcgc-remove_deprecation-2025-2-20-13-57-34.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Rollback change of `SdkApiVersionParameter`.

.chronus/changes/tcgc-remove_deprecation-2025-2-20-15-49-17.md

@@ -0,0 +1,7 @@
+---
+changeKind: breaking
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Removed `package-name` and `flatten-union-as-enum` from `SdkEmitterOptions`, `clientNamespace` from `SdkClientType`/`SdkNullableType`/`SdkEnumType`/`SdkUnionType`/`SdkModelType`, `packageName` from `TCGCContext`, `nameSpace` from `SdkClientType`, `name`/`rootNamespace` from `SdkPackage` and `getClientNamespaceString` function. All these things should have been deprecated in previous version or not used by any emitters.

packages/typespec-client-generator-core/README.md

@@ -39,7 +39,7 @@ options:
 
 **Type:** `string`
 
-Set `emitter-name` to output TCGC code models for specific language's emitter. This flag only work for taking TCGC as an emitter.
+Set `emitter-name` to output TCGC code models for specific language's emitter.
 
 ### `generate-protocol-methods`
 
@@ -53,14 +53,6 @@ When set to `true`, the emitter will generate low-level protocol methods for eac
 
 When set to `true`, the emitter will generate low-level protocol methods for each service operation if `@convenientAPI` is not set for an operation. Default value is `true`.
 
-### `package-name`
-
-**Type:** `string`
-
-### `flatten-union-as-enum`
-
-**Type:** `boolean`
-
 ### `examples-dir`
 
 **Type:** `string`

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

@@ -18,7 +18,6 @@ import { handleClientExamples } from "./example.js";
 import {
   getKnownScalars,
   SdkContext,
-  SdkEmitterOptions,
   SdkEnumType,
   SdkHttpOperation,
   SdkModelPropertyType,
@@ -35,6 +34,25 @@ import {
 } from "./internal-utils.js";
 import { getSdkPackage } from "./package.js";
 
+export interface TCGCEmitterOptions extends SdkEmitterOptions {
+  "emitter-name"?: string;
+}
+
+export interface SdkEmitterOptions {
+  "generate-protocol-methods"?: boolean;
+  "generate-convenience-methods"?: boolean;
+  "api-version"?: string;
+  "examples-dir"?: string;
+  namespace?: string;
+  license?: {
+    name: string;
+    company?: string;
+    link?: string;
+    header?: string;
+    description?: string;
+  };
+}
+
 export function createTCGCContext(program: Program, emitterName?: string): TCGCContext {
   const diagnostics = createDiagnosticCollector();
   return {
@@ -113,25 +131,20 @@ export async function createSdkContext<
     context.program,
     emitterName ?? context.options["emitter-name"],
   );
-  let flattenUnionAsEnum = options?.flattenUnionAsEnum;
-  if (flattenUnionAsEnum === undefined) {
-    flattenUnionAsEnum = context.options["flatten-union-as-enum"] ?? true;
-  }
   const sdkContext: SdkContext<TOptions, TServiceOperation> = {
     ...tcgcContext,
     emitContext: context,
     sdkPackage: undefined!,
     generateProtocolMethods: generateProtocolMethods,
     generateConvenienceMethods: generateConvenienceMethods,
-    packageName: context.options["package-name"],
     examplesDir: context.options["examples-dir"],
     namespaceFlag: context.options["namespace"],
     apiVersion: options?.versioning?.strategy === "ignore" ? "all" : context.options["api-version"],
     license: context.options["license"],
     decoratorsAllowList: [...defaultDecoratorsAllowList, ...(options?.additionalDecorators ?? [])],
     previewStringRegex: options?.versioning?.previewStringRegex || tcgcContext.previewStringRegex,
     disableUsageAccessPropagationToBase: options?.disableUsageAccessPropagationToBase ?? false,
-    flattenUnionAsEnum,
+    flattenUnionAsEnum: options?.flattenUnionAsEnum ?? true,
   };
   sdkContext.sdkPackage = diagnostics.pipe(getSdkPackage(sdkContext));
   for (const client of sdkContext.sdkPackage.clients) {
@@ -168,7 +181,7 @@ async function exportTCGCOutput(context: SdkContext) {
   });
 }
 
-export async function $onEmit(context: EmitContext<SdkEmitterOptions>) {
+export async function $onEmit(context: EmitContext<TCGCEmitterOptions>) {
   if (!context.program.compilerOptions.noEmit) {
     const sdkContext = await createSdkContext(context, undefined, { exportTCGCoutput: true });
     context.program.reportDiagnostics(sdkContext.diagnostics);

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

@@ -575,7 +575,7 @@ export function getCorrespondingMethodParams(
   }
 
   // 2. To see if the service parameter is api version parameter that has been elevated to client.
-  if (isApiVersion(context, serviceParam) && serviceParam.onClient) {
+  if (serviceParam.isApiVersionParam && serviceParam.onClient) {
     const existingApiVersion = clientParams?.find((x) => isApiVersion(context, x));
     if (!existingApiVersion) {
       diagnostics.add(

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

@@ -39,10 +39,6 @@ export interface TCGCContext {
 
   generateProtocolMethods?: boolean;
   generateConvenienceMethods?: boolean;
-  /**
-   * @deprecated Use `namespaceFlag` instead.
-   */
-  packageName?: string;
   examplesDir?: string;
   namespaceFlag?: string;
   apiVersion?: string;
@@ -85,27 +81,6 @@ export interface SdkContext<
   sdkPackage: SdkPackage<TServiceOperation>;
 }
 
-export interface SdkEmitterOptions {
-  "emitter-name"?: string;
-  "generate-protocol-methods"?: boolean;
-  "generate-convenience-methods"?: boolean;
-  /**
-   * @deprecated Use the `package-name` option on your language emitter instead, if it exists.
-   */
-  "package-name"?: string;
-  "flatten-union-as-enum"?: boolean;
-  "api-version"?: string;
-  "examples-dir"?: string;
-  namespace?: string;
-  license?: {
-    name: string;
-    company?: string;
-    link?: string;
-    header?: string;
-    description?: string;
-  };
-}
-
 // Types for TCGC customization decorators
 
 export interface SdkClient {
@@ -199,10 +174,6 @@ export interface SdkClientType<TServiceOperation extends SdkServiceOperation>
   __raw: SdkClient | SdkOperationGroup;
   kind: "client";
   name: string;
-  /**
-   * @deprecated Use `namespace` instead.
-   */
-  clientNamespace: string;
   /**
    * Full qualified namespace.
    */
@@ -216,10 +187,6 @@ export interface SdkClientType<TServiceOperation extends SdkServiceOperation>
   clientInitialization: SdkClientInitializationType;
   methods: SdkMethod<TServiceOperation>[];
   apiVersions: string[];
-  /**
-   * @deprecated Use `clientNamespace` instead.
-   */
-  nameSpace: string; // fully qualified
   crossLanguageDefinitionId: string;
   // The parent client of this client. The structure follows the definition hierarchy.
   parent?: SdkClientType<TServiceOperation>;
@@ -416,10 +383,6 @@ export interface SdkNullableType extends SdkTypeBase {
   type: SdkType;
   usage: UsageFlags;
   access: AccessFlags;
-  /**
-   * @deprecated Use `namespace` instead.
-   */
-  clientNamespace: string;
   /**
    * Full qualified namespace.
    */
@@ -430,10 +393,6 @@ export interface SdkEnumType extends SdkTypeBase {
   kind: "enum";
   name: string;
   isGeneratedName: boolean;
-  /**
-   * @deprecated Use `namespace` instead.
-   */
-  clientNamespace: string;
   /**
    * Full qualified namespace.
    */
@@ -469,10 +428,6 @@ export interface SdkConstantType extends SdkTypeBase {
 export interface SdkUnionType<TValueType extends SdkTypeBase = SdkType> extends SdkTypeBase {
   name: string;
   isGeneratedName: boolean;
-  /**
-   * @deprecated Use `namespace` instead.
-   */
-  clientNamespace: string;
   /**
    * Full qualified namespace.
    */
@@ -489,10 +444,6 @@ export interface SdkModelType extends SdkTypeBase {
   properties: SdkModelPropertyType[];
   name: string;
   isGeneratedName: boolean;
-  /**
-   * @deprecated Use `namespace` instead.
-   */
-  clientNamespace: string;
   /**
    * Full qualified namespace.
    */
@@ -543,9 +494,6 @@ export interface SdkModelPropertyTypeBase<TType extends SdkTypeBase = SdkType>
   apiVersions: string[];
   onClient: boolean;
   clientDefaultValue?: unknown;
-  /**
-   * @deprecated This property is deprecated. See if the kind is `apiVersion` instead
-   */
   isApiVersionParam: boolean;
   optional: boolean;
   crossLanguageDefinitionId: string;
@@ -607,34 +555,17 @@ export interface SdkEndpointParameter
   serializedName?: string;
 }
 
-export interface SdkApiVersionParameter
-  extends SdkModelPropertyTypeBase<
-    SdkBuiltInType<"string"> | SdkEnumValueType<SdkBuiltInType<"string">>
-  > {
-  kind: "apiVersion";
-  onClient: true;
-  type: SdkBuiltInType<"string"> | SdkEnumValueType<SdkBuiltInType<"string">>;
-  isApiVersionParam: true;
-}
-
 export interface SdkCredentialParameter
   extends SdkModelPropertyTypeBase<SdkCredentialType | SdkUnionType<SdkCredentialType>> {
   kind: "credential";
   onClient: true;
 }
 
-export type SdkModelPropertyType<TType extends SdkTypeBase = SdkType> =
-  | SdkBodyModelPropertyType<TType>
-  | SdkParameter<TType>
-  | SdkEndpointParameter
-  | SdkCredentialParameter
-  | SdkApiVersionParameter
-  | SdkQueryParameter<TType>
-  | SdkPathParameter<TType>
-  | SdkBodyParameter<TType>
-  | SdkHeaderParameter<TType>
-  | SdkCookieParameter<TType>
-  | SdkServiceResponseHeader<TType>;
+export type SdkModelPropertyType =
+  | SdkBodyModelPropertyType
+  | SdkParameter
+  | SdkHttpParameter
+  | SdkServiceResponseHeader;
 
 export interface MultipartOptions {
   name: string;
@@ -650,8 +581,7 @@ export interface MultipartOptions {
   defaultContentTypes: string[];
 }
 
-export interface SdkBodyModelPropertyType<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkBodyModelPropertyType extends SdkModelPropertyTypeBase {
   kind: "property";
   discriminator: boolean;
   /**
@@ -672,25 +602,22 @@ export interface SdkBodyModelPropertyType<TType extends SdkTypeBase = SdkType>
 
 export type CollectionFormat = "multi" | "csv" | "ssv" | "tsv" | "pipes" | "simple" | "form";
 
-export interface SdkHeaderParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkHeaderParameter extends SdkModelPropertyTypeBase {
   kind: "header";
   collectionFormat?: CollectionFormat;
   serializedName: string;
   correspondingMethodParams: SdkModelPropertyType[];
 }
 
-export interface SdkQueryParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkQueryParameter extends SdkModelPropertyTypeBase {
   kind: "query";
   collectionFormat?: CollectionFormat;
   serializedName: string;
   correspondingMethodParams: SdkModelPropertyType[];
   explode: boolean;
 }
 
-export interface SdkPathParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkPathParameter extends SdkModelPropertyTypeBase {
   kind: "path";
   /**
    * @deprecated This property is deprecated. Use `allowReserved` instead.
@@ -705,15 +632,13 @@ export interface SdkPathParameter<TType extends SdkTypeBase = SdkType>
   correspondingMethodParams: SdkModelPropertyType[];
 }
 
-export interface SdkCookieParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkCookieParameter extends SdkModelPropertyTypeBase {
   kind: "cookie";
   serializedName: string;
   correspondingMethodParams: SdkModelPropertyType[];
 }
 
-export interface SdkBodyParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkBodyParameter extends SdkModelPropertyTypeBase {
   kind: "body";
   serializedName: string;
   optional: boolean;
@@ -729,13 +654,11 @@ export type SdkHttpParameter =
   | SdkHeaderParameter
   | SdkCookieParameter;
 
-export interface SdkMethodParameter<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkMethodParameter extends SdkModelPropertyTypeBase {
   kind: "method";
 }
 
-export interface SdkServiceResponseHeader<TType extends SdkTypeBase = SdkType>
-  extends SdkModelPropertyTypeBase<TType> {
+export interface SdkServiceResponseHeader extends SdkModelPropertyTypeBase {
   __raw: ModelProperty;
   kind: "responseheader";
   serializedName: string;
@@ -778,11 +701,7 @@ export interface SdkHttpErrorResponse extends SdkHttpResponseBase {
 
 interface SdkServiceOperationBase {}
 
-export type SdkParameter<TType extends SdkTypeBase = SdkType> =
-  | SdkEndpointParameter
-  | SdkCredentialParameter
-  | SdkApiVersionParameter
-  | SdkMethodParameter<TType>;
+export type SdkParameter = SdkEndpointParameter | SdkCredentialParameter | SdkMethodParameter;
 
 export interface SdkHttpOperation extends SdkServiceOperationBase {
   __raw: HttpOperation;
@@ -970,11 +889,6 @@ export type SdkMethod<TServiceOperation extends SdkServiceOperation> =
   | SdkClientAccessor<TServiceOperation>; // eslint-disable-line @typescript-eslint/no-deprecated
 
 export interface SdkPackage<TServiceOperation extends SdkServiceOperation> {
-  name: string;
-  /**
-   * @deprecated Look at `.namespaces` instead
-   */
-  rootNamespace: string;
   clients: SdkClientType<TServiceOperation>[];
   models: SdkModelType[];
   enums: SdkEnumType[];