@azure-tools/typespec-ts 0.54.0 → 0.55.0-dev.6

package/src/transform/transformHelperFunctionDetails.ts

@@ -1,22 +1,19 @@
+import { getHttpOperationWithCache, SdkClient } from "@azure-tools/typespec-client-generator-core";
 import { HelperFunctionDetails, PackageFlavor } from "../rlc-common/index.js";
-import {
-  getHttpOperationWithCache,
-  SdkClient
-} from "@azure-tools/typespec-client-generator-core";
+import { listOperationsUnderRLCClient } from "../utils/clientUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
+import { getCollectionFormat } from "../utils/modelUtils.js";
 import {
   extractPageDetails,
   getSpecialSerializeInfo,
   hasPagingOperations,
-  hasPollingOperations
+  hasPollingOperations,
 } from "../utils/operationUtil.js";
-import { getCollectionFormat } from "../utils/modelUtils.js";
-import { listOperationsUnderRLCClient } from "../utils/clientUtils.js";
 
 export function transformHelperFunctionDetails(
   client: SdkClient,
   dpgContext: SdkContext,
-  flavor?: PackageFlavor
+  flavor?: PackageFlavor,
 ): HelperFunctionDetails {
   const serializeInfo = extractSpecialSerializeInfo(client, dpgContext);
   // Disable paging and long running for non-Azure clients.
@@ -24,18 +21,18 @@ export function transformHelperFunctionDetails(
     return {
       hasLongRunning: false,
       hasPaging: false,
-      ...serializeInfo
+      ...serializeInfo,
     };
   }
 
   const annotationDetails = {
-    hasLongRunning: hasPollingOperations(client, dpgContext)
+    hasLongRunning: hasPollingOperations(client, dpgContext),
   };
   const details = extractClientPageDetails(client, dpgContext);
   return {
     ...(details ?? {}),
     ...annotationDetails,
-    ...serializeInfo
+    ...serializeInfo,
   };
 }
 
@@ -65,36 +62,27 @@ function extractClientPageDetails(client: SdkClient, dpgContext: SdkContext) {
     pageDetails: {
       itemNames: [...itemNames],
       nextLinkNames: [...nextLinks],
-      isComplexPaging: nextLinks.size > 1 || itemNames.size > 1
-    }
+      isComplexPaging: nextLinks.size > 1 || itemNames.size > 1,
+    },
   };
 }
 
-function extractSpecialSerializeInfo(
-  client: SdkClient,
-  dpgContext: SdkContext
-) {
+function extractSpecialSerializeInfo(client: SdkClient, dpgContext: SdkContext) {
   let hasMultiCollection = false;
   let hasCsvCollection = false;
   for (const op of listOperationsUnderRLCClient(client)) {
     const route = getHttpOperationWithCache(dpgContext, op);
     route.parameters.parameters.forEach((parameter) => {
       const format = getCollectionFormat(dpgContext, parameter as any);
-      const serializeInfo = getSpecialSerializeInfo(
-        dpgContext,
-        parameter.type,
-        format!
-      );
+      const serializeInfo = getSpecialSerializeInfo(dpgContext, parameter.type, format!);
       hasMultiCollection = hasMultiCollection
         ? hasMultiCollection
         : serializeInfo.hasMultiCollection;
-      hasCsvCollection = hasCsvCollection
-        ? hasCsvCollection
-        : serializeInfo.hasCsvCollection;
+      hasCsvCollection = hasCsvCollection ? hasCsvCollection : serializeInfo.hasCsvCollection;
     });
   }
   return {
     hasMultiCollection,
-    hasCsvCollection
+    hasCsvCollection,
   };
 }

package/src/transform/transformParameters.ts

@@ -1,6 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import {
+  SdkClient,
+  getHttpOperationWithCache,
+  isApiVersion,
+} from "@azure-tools/typespec-client-generator-core";
+import { NoTarget, Type, isVoidType } from "@typespec/compiler";
+import { HttpOperation, HttpOperationParameter, HttpOperationParameters } from "@typespec/http";
+import { reportDiagnostic } from "../lib.js";
 import {
   ApiVersionInfo,
   Imports,
@@ -9,25 +17,16 @@ import {
   ParameterBodyMetadata,
   ParameterMetadata,
   Schema,
-  SchemaContext
+  SchemaContext,
 } from "../rlc-common/index.js";
-import {
-  HttpOperation,
-  HttpOperationParameter,
-  HttpOperationParameters
-} from "@typespec/http";
+import { listOperationsUnderRLCClient } from "../utils/clientUtils.js";
+import { SdkContext } from "../utils/interfaces.js";
 import {
   KnownMediaType,
   extractMediaTypes,
   hasMediaType,
-  isMediaTypeJsonMergePatch
+  isMediaTypeJsonMergePatch,
 } from "../utils/mediaTypes.js";
-import {
-  SdkClient,
-  getHttpOperationWithCache,
-  isApiVersion
-} from "@azure-tools/typespec-client-generator-core";
-import { NoTarget, Type, isVoidType } from "@typespec/compiler";
 import {
   getBodyType,
   getCollectionFormat,
@@ -36,17 +35,14 @@ import {
   getSchemaForType,
   getTypeName,
   isArrayType,
-  isBodyRequired
+  isBodyRequired,
 } from "../utils/modelUtils.js";
 import {
   getOperationGroupName,
   getOperationName,
-  getSpecialSerializeInfo
+  getSpecialSerializeInfo,
 } from "../utils/operationUtil.js";
-import { SdkContext } from "../utils/interfaces.js";
 import { getParameterSerializationInfo } from "../utils/parameterUtils.js";
-import { reportDiagnostic } from "../lib.js";
-import { listOperationsUnderRLCClient } from "../utils/clientUtils.js";
 
 interface ParameterTransformationOptions {
   apiVersionInfo?: ApiVersionInfo;
@@ -59,7 +55,7 @@ export function transformToParameterTypes(
   client: SdkClient,
   dpgContext: SdkContext,
   importDetails: Imports,
-  apiVersionInfo?: ApiVersionInfo
+  apiVersionInfo?: ApiVersionInfo,
 ): OperationParameter[] {
   const rlcParameters: OperationParameter[] = [];
   const outputImportedSet = new Set<string>();
@@ -80,30 +76,22 @@ export function transformToParameterTypes(
     const rlcParameter: OperationParameter = {
       operationGroup: getOperationGroupName(dpgContext, route),
       operationName: getOperationName(dpgContext, route.operation),
-      parameters: []
+      parameters: [],
     };
     const options = {
       apiVersionInfo,
       operationGroupName: rlcParameter.operationGroup,
       operationName: rlcParameter.operationName,
-      importModels: outputImportedSet
+      importModels: outputImportedSet,
     };
     // transform query param
-    const queryParams = transformQueryParameters(
-      dpgContext,
-      parameters,
-      options
-    );
+    const queryParams = transformQueryParameters(dpgContext, parameters, options);
     // transform path param
     const pathParams = transformPathParameters(dpgContext, parameters, options);
     // TODO: support cookie parameters, https://github.com/Azure/autorest.typescript/issues/2898
     transformCookieParameters(dpgContext, parameters);
     // transform header param including content-type
-    const headerParams = transformHeaderParameters(
-      dpgContext,
-      parameters,
-      options
-    );
+    const headerParams = transformHeaderParameters(dpgContext, parameters, options);
     // transform body
     const bodyType = getBodyType(route);
     let bodyParameter = undefined;
@@ -113,12 +101,12 @@ export function transformToParameterTypes(
         parameters,
         headerParams,
         outputImportedSet,
-        bodyType
+        bodyType,
       );
     }
     rlcParameter.parameters.push({
       parameters: [...queryParams, ...pathParams, ...headerParams],
-      body: bodyParameter
+      body: bodyParameter,
     });
     rlcParameters.push(rlcParameter);
   }
@@ -129,7 +117,7 @@ function getParameterMetadata(
   dpgContext: SdkContext,
   paramType: "query" | "path" | "header",
   parameter: HttpOperationParameter,
-  options: ParameterTransformationOptions
+  options: ParameterTransformationOptions,
 ): ParameterMetadata {
   const program = dpgContext.program;
   const importedModels = options.importModels ?? new Set<string>();
@@ -137,23 +125,18 @@ function getParameterMetadata(
   const schema = getSchemaForType(dpgContext, parameter.param.type, {
     usage: schemaContext,
     needRef: false,
-    relevantProperty: parameter.param
+    relevantProperty: parameter.param,
   }) as Schema;
   const name = getParameterName(parameter.name);
-  let description =
-    getFormattedPropertyDoc(program, parameter.param, schema) ?? "";
+  let description = getFormattedPropertyDoc(program, parameter.param, schema) ?? "";
   const format = getCollectionFormat(dpgContext, parameter as any);
   if (isArrayType(schema) && format) {
-    const serializeInfo = getSpecialSerializeInfo(
-      dpgContext,
-      parameter.type,
-      format
-    );
+    const serializeInfo = getSpecialSerializeInfo(dpgContext, parameter.type, format);
     if (serializeInfo.hasMultiCollection || serializeInfo.hasCsvCollection) {
       description += `${description ? "\n" : ""}This parameter could be formatted as ${serializeInfo.collectionInfo.join(
-        ", "
+        ", ",
       )} collection string, we provide ${serializeInfo.descriptions.join(
-        ", "
+        ", ",
       )} from serializeHelper.ts to help${
         serializeInfo.hasMultiCollection
           ? ", you will probably need to set skipUrlEncoding as true when sending the request"
@@ -165,16 +148,13 @@ function getParameterMetadata(
     }
   }
 
-  getImportedModelName(schema, schemaContext)?.forEach(
-    importedModels.add,
-    importedModels
-  );
+  getImportedModelName(schema, schemaContext)?.forEach(importedModels.add, importedModels);
   const serializationType = getParameterSerializationInfo(
     dpgContext,
     parameter,
     schema,
     options.operationGroupName,
-    options.operationName
+    options.operationName,
   );
   return {
     type: paramType,
@@ -185,8 +165,8 @@ function getParameterMetadata(
       typeName: serializationType.typeName,
       required: !parameter.param.optional,
       description,
-      wrapperType: serializationType.wrapperType
-    }
+      wrapperType: serializationType.wrapperType,
+    },
   };
 }
 
@@ -197,10 +177,7 @@ function getParameterName(name: string) {
   return `"${name}"`;
 }
 
-function transformCookieParameters(
-  dpgContext: SdkContext,
-  parameters: HttpOperationParameters
-) {
+function transformCookieParameters(dpgContext: SdkContext, parameters: HttpOperationParameters) {
   // TODO: support cookie parameters, https://github.com/Azure/autorest.typescript/issues/2898
   parameters.parameters
     .filter((p) => p.type === "cookie")
@@ -209,9 +186,9 @@ function transformCookieParameters(
         code: "parameter-type-not-supported",
         format: {
           paramName: p.name,
-          paramType: p.type
+          paramType: p.type,
         },
-        target: NoTarget
+        target: NoTarget,
       });
     });
 }
@@ -219,22 +196,17 @@ function transformCookieParameters(
 function transformQueryParameters(
   dpgContext: SdkContext,
   parameters: HttpOperationParameters,
-  options: ParameterTransformationOptions
+  options: ParameterTransformationOptions,
 ): ParameterMetadata[] {
   const queryParameters = parameters.parameters.filter(
     (p) =>
       p.type === "query" &&
-      !(
-        isApiVersion(dpgContext, p.param) &&
-        options.apiVersionInfo?.definedPosition === "query"
-      )
+      !(isApiVersion(dpgContext, p.param) && options.apiVersionInfo?.definedPosition === "query"),
   );
   if (!queryParameters.length) {
     return [];
   }
-  return queryParameters.map((qp) =>
-    getParameterMetadata(dpgContext, "query", qp, options)
-  );
+  return queryParameters.map((qp) => getParameterMetadata(dpgContext, "query", qp, options));
 }
 
 /**
@@ -244,7 +216,7 @@ function transformQueryParameters(
 function transformPathParameters(
   dpgContext: SdkContext,
   parameters: HttpOperationParameters,
-  options: ParameterTransformationOptions
+  options: ParameterTransformationOptions,
 ) {
   // build wrapper path parameters
   const pathParameters = parameters.parameters.filter((p) => p.type === "path");
@@ -261,17 +233,13 @@ function transformPathParameters(
 export function transformHeaderParameters(
   dpgContext: SdkContext,
   parameters: HttpOperationParameters,
-  options: ParameterTransformationOptions
+  options: ParameterTransformationOptions,
 ): ParameterMetadata[] {
-  const headerParameters = parameters.parameters.filter(
-    (p) => p.type === "header"
-  );
+  const headerParameters = parameters.parameters.filter((p) => p.type === "header");
   if (!headerParameters.length) {
     return [];
   }
-  return headerParameters.map((qp) =>
-    getParameterMetadata(dpgContext, "header", qp, options)
-  );
+  return headerParameters.map((qp) => getParameterMetadata(dpgContext, "header", qp, options));
 }
 
 function transformBodyParameters(
@@ -279,20 +247,13 @@ function transformBodyParameters(
   parameters: HttpOperationParameters,
   headers: ParameterMetadata[],
   importedModels: Set<string>,
-  inputBodyType?: Type
+  inputBodyType?: Type,
 ): ParameterBodyMetadata | undefined {
-  const bodyType =
-    parameters.body && inputBodyType ? inputBodyType : parameters.body?.type;
+  const bodyType = parameters.body && inputBodyType ? inputBodyType : parameters.body?.type;
   if (!bodyType || isVoidType(bodyType)) {
     return;
   }
-  return transformRequestBody(
-    dpgContext,
-    bodyType,
-    parameters,
-    importedModels,
-    headers
-  );
+  return transformRequestBody(dpgContext, bodyType, parameters, importedModels, headers);
 }
 
 function transformRequestBody(
@@ -300,13 +261,13 @@ function transformRequestBody(
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>,
-  headers: ParameterMetadata[]
+  headers: ParameterMetadata[],
 ) {
   const contentTypes = extractMediaTypes(parameters.body?.contentTypes ?? []);
   const schema = getSchemaForType(dpgContext, bodyType, {
     mediaTypes: contentTypes,
     isRequestBody: true,
-    usage: [SchemaContext.Input, SchemaContext.Exception]
+    usage: [SchemaContext.Input, SchemaContext.Exception],
   });
 
   const descriptions = getBodyDescriptions(dpgContext, schema, parameters);
@@ -323,33 +284,26 @@ function transformRequestBody(
         required: isBodyRequired(parameters),
         description: descriptions.join("\n\n"),
         isMultipartBody:
-          hasMediaType(KnownMediaType.MultipartFormData, contentTypes) &&
-          contentTypes.length === 1,
-        oriSchema: schema
-      }
-    ]
+          hasMediaType(KnownMediaType.MultipartFormData, contentTypes) && contentTypes.length === 1,
+        oriSchema: schema,
+      },
+    ],
   };
 }
 
 function getRequestBodyType(
   bodySchema: Schema,
   importedModels: Set<string>,
-  headers?: ParameterMetadata[]
+  headers?: ParameterMetadata[],
 ) {
   const schemaUsage = [SchemaContext.Input, SchemaContext.Exception];
   const importedNames = getImportedModelName(bodySchema, schemaUsage) ?? [];
   importedNames.forEach(importedModels.add, importedModels);
 
   let typeName = getTypeName(bodySchema, schemaUsage);
-  const contentTypes = headers
-    ?.filter((h) => h.name === "contentType")
-    .map((h) => h.param.type);
+  const contentTypes = headers?.filter((h) => h.name === "contentType").map((h) => h.param.type);
   const hasMergeAndPatchType = isMediaTypeJsonMergePatch(contentTypes ?? []);
-  if (
-    hasMergeAndPatchType &&
-    Boolean(bodySchema.name) &&
-    (bodySchema as ObjectSchema).properties
-  ) {
+  if (hasMergeAndPatchType && Boolean(bodySchema.name) && (bodySchema as ObjectSchema).properties) {
     typeName = `${typeName}ResourceMergeAndPatch`;
   }
   return typeName;
@@ -358,14 +312,10 @@ function getRequestBodyType(
 function getBodyDescriptions(
   dpgContext: SdkContext,
   bodySchema: Schema,
-  parameters: HttpOperationParameters
+  parameters: HttpOperationParameters,
 ) {
   const description = parameters.body?.property
-    ? getFormattedPropertyDoc(
-        dpgContext.program,
-        parameters.body.property,
-        bodySchema
-      )
+    ? getFormattedPropertyDoc(dpgContext.program, parameters.body.property, bodySchema)
     : "";
   return description ? [description] : [];
 }

package/src/transform/transformPaths.ts

@@ -1,6 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import {
+  SdkClient,
+  getHttpOperationWithCache,
+  isApiVersion,
+} from "@azure-tools/typespec-client-generator-core";
 import { HttpOperation, HttpOperationParameters } from "@typespec/http";
 import {
   Imports,
@@ -9,13 +14,9 @@ import {
   Paths,
   SchemaContext,
   getParameterTypeName,
-  getResponseTypeName
+  getResponseTypeName,
 } from "../rlc-common/index.js";
-import {
-  SdkClient,
-  getHttpOperationWithCache,
-  isApiVersion
-} from "@azure-tools/typespec-client-generator-core";
+import { getImportedModelName, getSchemaForType, isBodyRequired } from "../utils/modelUtils.js";
 import {
   extractOperationLroDetail,
   getOperationGroupName,
@@ -24,23 +25,18 @@ import {
   getOperationStatuscode,
   getOperationSuccessStatus,
   isPagingOperation,
-  sortedOperationResponses
+  sortedOperationResponses,
 } from "../utils/operationUtil.js";
-import {
-  getImportedModelName,
-  getSchemaForType,
-  isBodyRequired
-} from "../utils/modelUtils.js";
 
-import { SdkContext } from "../utils/interfaces.js";
 import { getDoc } from "@typespec/compiler";
-import { getParameterSerializationInfo } from "../utils/parameterUtils.js";
 import { listOperationsUnderRLCClient } from "../utils/clientUtils.js";
+import { SdkContext } from "../utils/interfaces.js";
+import { getParameterSerializationInfo } from "../utils/parameterUtils.js";
 
 export function transformPaths(
   client: SdkClient,
   dpgContext: SdkContext,
-  importDetails: Imports
+  importDetails: Imports,
 ): Paths {
   const pathParamsImportedSet = new Set<string>();
   const paths: Paths = {};
@@ -64,7 +60,7 @@ function transformOperation(
   dpgContext: SdkContext,
   route: HttpOperation,
   paths: Paths,
-  importSet: Set<string>
+  importSet: Set<string>,
 ) {
   const program = dpgContext.program;
   const respNames = [];
@@ -73,7 +69,7 @@ function transformOperation(
     const respName = getResponseTypeName(
       operationGroupName,
       getOperationName(dpgContext, route.operation),
-      getOperationStatuscode(resp)
+      getOperationStatuscode(resp),
     );
     respNames.push(respName);
   }
@@ -83,35 +79,25 @@ function transformOperation(
     hasOptionalOptions: !hasRequiredOptions(dpgContext, route.parameters),
     optionsName: getParameterTypeName(
       operationGroupName,
-      getOperationName(dpgContext, route.operation)
+      getOperationName(dpgContext, route.operation),
     ),
     responseTypes,
     returnType: respNames.join(" | "),
     successStatus: getOperationSuccessStatus(route),
     operationName: getOperationName(dpgContext, route.operation),
     operationHelperDetail: {
-      lroDetails: extractOperationLroDetail(
-        dpgContext,
-        route,
-        responseTypes,
-        operationGroupName
-      ),
-      isPaging: isPagingOperation(dpgContext, route)
-    }
+      lroDetails: extractOperationLroDetail(dpgContext, route, responseTypes, operationGroupName),
+      isPaging: isPagingOperation(dpgContext, route),
+    },
   };
-  if (
-    paths[route.path] !== undefined &&
-    !paths[route.path]?.methods[route.verb]
-  ) {
+  if (paths[route.path] !== undefined && !paths[route.path]?.methods[route.verb]) {
     (paths[route.path] as PathMetadata).methods[route.verb] = [method];
   } else if (paths[route.path]?.methods[route.verb]) {
     paths[route.path]?.methods[route.verb]?.push(method);
   } else {
     paths[route.path] = {
       description: getDoc(program, route.operation) ?? "",
-      name: escapeCoreName(
-        getOperationName(dpgContext, route.operation) || "Client"
-      ),
+      name: escapeCoreName(getOperationName(dpgContext, route.operation) || "Client"),
       pathParameters: route.parameters.parameters
         .filter((p) => p.type === "path")
         .map((p) => {
@@ -119,14 +105,14 @@ function transformOperation(
           const options = {
             usage: schemaUsage,
             needRef: false,
-            relevantProperty: p.param
+            relevantProperty: p.param,
           };
           const schema = p.param.sourceProperty
             ? getSchemaForType(
                 dpgContext,
                 p.param.sourceProperty?.type,
 
-                options
+                options,
               )
             : getSchemaForType(dpgContext, p.param.type, options);
           const importedNames = getImportedModelName(schema, schemaUsage) ?? [];
@@ -136,19 +122,19 @@ function transformOperation(
             p,
             schema,
             operationGroupName,
-            method.operationName
+            method.operationName,
           );
           return {
             name: p.name,
             type: serializationType.typeName,
             description: getDoc(program, p.param) ?? "",
-            wrapperType: serializationType.wrapperType
+            wrapperType: serializationType.wrapperType,
           };
         }),
       operationGroupName: getOperationGroupName(dpgContext, route),
       methods: {
-        [route.verb]: [method]
-      }
+        [route.verb]: [method],
+      },
     };
   }
 }
@@ -159,10 +145,7 @@ function escapeCoreName(name: string) {
   }
   return name;
 }
-function hasRequiredOptions(
-  dpgContext: SdkContext,
-  routeParameters: HttpOperationParameters
-) {
+function hasRequiredOptions(dpgContext: SdkContext, routeParameters: HttpOperationParameters) {
   const isRequiredBodyParam = isBodyRequired(routeParameters);
 
   const containsRequiredNonBodyParam = routeParameters.parameters