[tcgc] support generic type decorators in sdk types

.chronus/changes/decorators_list-2024-5-6-18-38-7.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+export decorators in white list to all sdk types

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

@@ -607,6 +607,7 @@ export function createSdkContext<
     __namespaceToApiVersionParameter: new Map(),
     __tspTypeToApiVersions: new Map(),
     __namespaceToApiVersionClientDefaultValue: new Map(),
+    decoratorsWhiteList: context.options["decorators-white-list"] ?? [],
   };
   sdkContext.experimental_sdkPackage = getSdkPackage(sdkContext);
   if (sdkContext.diagnostics) {

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

@@ -42,6 +42,7 @@ import {
   getAvailableApiVersions,
   getDocHelper,
   getLocationOfOperation,
+  getTypeDecorators,
   isAcceptHeader,
   isContentTypeHeader,
   isNeverOrVoidType,
@@ -166,6 +167,7 @@ function getSdkHttpParameters(
         optional: false,
         correspondingMethodParams,
         crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, httpOperation.operation)}.body`,
+        decorators: getTypeDecorators(context, tspBody.type),
       };
     }
     if (retval.bodyParam) {
@@ -234,6 +236,7 @@ function createContentTypeOrAcceptHeader(
   let type: SdkType = {
     kind: "string",
     encode: "string",
+    decorators: {},
   };
   // for contentType, we treat it as a constant IFF there's one value and it's application/json.
   // this is to prevent a breaking change when a service adds more content types in the future.
@@ -254,6 +257,7 @@ function createContentTypeOrAcceptHeader(
       valueType: type,
       name: `${httpOperation.operation.name}ContentType`,
       isGeneratedName: true,
+      decorators: {},
     };
   }
   // No need for clientDefaultValue because it's a constant, it only has one value
@@ -267,6 +271,7 @@ function createContentTypeOrAcceptHeader(
     onClient: false,
     optional: false,
     crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, httpOperation.operation)}.${name}`,
+    decorators: {},
   };
 }
 

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

@@ -36,6 +36,7 @@ export interface SdkEmitterOptions {
   "package-name"?: string;
   "flatten-union-as-enum"?: boolean;
   "api-version"?: string;
+  "decorators-white-list"?: string[];
 }
 
 export interface SdkClient {
@@ -54,7 +55,8 @@ export interface SdkInitializationType extends SdkModelType {
   properties: SdkParameter[];
 }
 
-export interface SdkClientType<TServiceOperation extends SdkServiceOperation> {
+export interface SdkClientType<TServiceOperation extends SdkServiceOperation>
+  extends DecoratedType {
   kind: "client";
   name: string;
   description?: string;
@@ -77,7 +79,11 @@ export interface SdkOperationGroup {
   service: Namespace;
 }
 
-interface SdkTypeBase {
+interface DecoratedType {
+  decorators: Record<string, Array<any>>;
+}
+
+interface SdkTypeBase extends DecoratedType {
   __raw?: Type;
   kind: string;
   deprecation?: string;
@@ -318,7 +324,7 @@ export interface SdkEndpointType extends SdkTypeBase {
   templateArguments: SdkPathParameter[];
 }
 
-export interface SdkModelPropertyTypeBase {
+export interface SdkModelPropertyTypeBase extends DecoratedType {
   __raw?: ModelProperty;
   type: SdkType;
   /**
@@ -461,7 +467,7 @@ export interface SdkHttpOperation extends SdkServiceOperationBase {
 export type SdkServiceOperation = SdkHttpOperation;
 export type SdkServiceParameter = SdkHttpParameter;
 
-interface SdkMethodBase {
+interface SdkMethodBase extends DecoratedType {
   __raw?: Operation;
   name: string;
   access: AccessFlags;

packages/typespec-client-generator-core/src/internal-utils.ts

@@ -4,13 +4,15 @@ import {
   Interface,
   Model,
   Namespace,
+  Numeric,
   NumericLiteral,
   Operation,
   Program,
   ProjectedProgram,
   StringLiteral,
   Type,
   Union,
+  Value,
   createDiagnosticCollector,
   getDeprecationDetails,
   getDoc,
@@ -242,6 +244,7 @@ interface DefaultSdkTypeBase<TKind> {
   __raw: Type;
   deprecation?: string;
   kind: TKind;
+  decorators: Record<string, Array<any>>;
 }
 
 /**
@@ -257,9 +260,69 @@ export function getSdkTypeBaseHelper<TKind>(
     __raw: type,
     deprecation: getDeprecationDetails(context.program, type)?.message,
     kind,
+    decorators: getTypeDecorators(context, type),
   };
 }
 
+export function getTypeDecorators(context: TCGCContext, type: Type): Record<string, Array<any>> {
+  const retval: Record<string, Array<any>> = {};
+  if ("decorators" in type) {
+    for (const decorator of type.decorators) {
+      // only process explicitly defined decorators
+      if (decorator.definition) {
+        const decoratorName = `${decorator.definition?.namespace ? getNamespaceFullName(decorator.definition.namespace) + "." : ""}${decorator.definition?.name}`;
+        // white list filtering
+        if (!context.decoratorsWhiteList) {
+          continue;
+        }
+        let found = false;
+        for (const item of context.decoratorsWhiteList) {
+          if (decoratorName === item) {
+            found = true;
+            break;
+          }
+          const regex = new RegExp(item);
+          if (regex.test(decoratorName)) {
+            found = true;
+            break;
+          }
+        }
+        if (!found) {
+          continue;
+        }
+        retval[decoratorName] = [];
+        for (const arg of decorator.args) {
+          retval[decoratorName].push(getDecoratorArgValue(arg.jsValue));
+        }
+      }
+    }
+  }
+  return retval;
+}
+
+function getDecoratorArgValue(
+  arg:
+    | Type
+    | Record<string, unknown>
+    | Value
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | Numeric
+    | null
+): any {
+  if (typeof arg === "object" && arg !== null && "kind" in arg) {
+    if (arg.kind === "EnumMember") {
+      return arg.value ?? arg.name;
+    }
+    if (arg.kind === "String" || arg.kind === "Number" || arg.kind === "Boolean") {
+      return arg.value;
+    }
+  }
+  return arg;
+}
+
 export function intOrFloat(value: number): "int32" | "float32" {
   return value.toString().indexOf(".") === -1 ? "int32" : "float32";
 }
@@ -325,6 +388,7 @@ export interface TCGCContext {
   apiVersion?: string;
   __service_projection?: Map<Namespace, [Namespace, ProjectedProgram | undefined]>;
   originalProgram: Program;
+  decoratorsWhiteList?: string[];
 }
 
 export function createTCGCContext(program: Program): TCGCContext {
@@ -426,9 +490,10 @@ export function isNeverOrVoidType(type: Type): boolean {
   return isNeverType(type) || isVoidType(type);
 }
 
-export function getAnyType(): SdkBuiltInType {
+export function getAnyType(context: TCGCContext, type: Type): SdkBuiltInType {
   return {
     kind: "any",
     encode: "string",
+    decorators: getTypeDecorators(context, type),
   };
 }

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

@@ -55,6 +55,7 @@ import {
   getHashForType,
   getLocationOfOperation,
   getSdkTypeBaseHelper,
+  getTypeDecorators,
   isNeverOrVoidType,
   updateWithApiVersionInformation,
 } from "./internal-utils.js";
@@ -214,6 +215,7 @@ function getSdkMethodResponse<
       values: allResponseBodies,
       name: createGeneratedName(context, operation, "UnionResponse"),
       isGeneratedName: true,
+      decorators: {},
     };
   } else if (responseTypes) {
     type = allResponseBodies[0];
@@ -222,6 +224,7 @@ function getSdkMethodResponse<
     type = {
       kind: "nullable",
       type: type,
+      decorators: {},
     };
   }
   return {
@@ -307,6 +310,7 @@ function getSdkBasicServiceMethod<
       return undefined; // currently we only return a value for paging or lro
     },
     crossLanguageDefintionId: getCrossLanguageDefinitionId(context, operation),
+    decorators: getTypeDecorators(context, operation),
   });
 }
 
@@ -392,6 +396,7 @@ function getSdkInitializationType<
     apiVersions: context.__tspTypeToApiVersions.get(client.type)!,
     isFormDataType: false,
     isError: false,
+    decorators: {},
   });
 }
 
@@ -422,6 +427,7 @@ function getSdkMethodParameter(
       isApiVersionParam: false,
       onClient: false,
       crossLanguageDefinitionId: "anonymous",
+      decorators: getTypeDecorators(context, type),
     });
   }
   return diagnostics.wrap({
@@ -455,6 +461,7 @@ function getSdkMethods<TOptions extends object, TServiceOperation extends SdkSer
       response: operationGroupClient,
       apiVersions: getAvailableApiVersions(context, operationGroup.type, client.type),
       crossLanguageDefintionId: getCrossLanguageDefinitionId(context, operationGroup.type),
+      decorators: {},
     });
   }
   return diagnostics.wrap(retval);
@@ -494,8 +501,10 @@ function getSdkEndpointParameter(
           isApiVersionParam: false,
           apiVersions: context.__tspTypeToApiVersions.get(client.type)!,
           crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, client.service)}.endpoint`,
+          decorators: {},
         },
       ],
+      decorators: {},
     };
   } else {
     // this means we have one server
@@ -504,6 +513,7 @@ function getSdkEndpointParameter(
       kind: "endpoint",
       serverUrl: servers[0].url,
       templateArguments,
+      decorators: {},
     };
     for (const param of servers[0].parameters.values()) {
       const sdkParam = diagnostics.pipe(getSdkHttpParameter(context, param, undefined, "path"));
@@ -543,6 +553,7 @@ function getSdkEndpointParameter(
     optional,
     isApiVersionParam: false,
     crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, client.service)}.endpoint`,
+    decorators: {},
   });
 }
 
@@ -572,6 +583,7 @@ function createSdkClientType<
     ), // MUST call this after getSdkMethods has been called
     // eslint-disable-next-line deprecation/deprecation
     arm: client.kind === "SdkClient" ? client.arm : false,
+    decorators: getTypeDecorators(context, client.type),
   };
   context.__clients!.push(sdkClientType);
   return diagnostics.wrap(sdkClientType);