@azure-tools/typespec-ts 0.12.0 → 0.13.0

package/src/transform/transform.ts

@@ -16,6 +16,7 @@ import {
   RLCModel,
   RLCOptions,
   Schema,
+  SchemaContext,
   UrlInfo
 } from "@azure-tools/rlc-common";
 import { Program, getDoc } from "@typespec/compiler";
@@ -28,13 +29,14 @@ import {
   getTypeName,
   predictDefaultValue
 } from "../modelUtils.js";
-import { transformAnnotationDetails } from "./transformAnnotationDetails.js";
+import { transformHelperFunctionDetails } from "./transformHelperFunctionDetails.js";
 import { transformToParameterTypes } from "./transformParameters.js";
 import { transformPaths } from "./transformPaths.js";
 import { transformToResponseTypes } from "./transformResponses.js";
 import { transformSchemas } from "./transformSchemas.js";
 import { transformRLCOptions } from "./transfromRLCOptions.js";
 import { transformApiVersionInfo } from "./transformApiVersionInfo.js";
+import { getClientLroOverload } from "../operationUtil.js";
 
 export async function transformRLCModel(
   program: Program,
@@ -80,7 +82,13 @@ export async function transformRLCModel(
     client,
     dpgContext
   );
-  const annotations = transformAnnotationDetails(program, client, dpgContext);
+  const helperDetails = transformHelperFunctionDetails(
+    program,
+    client,
+    dpgContext
+  );
+  // Enrich client-level annotation detail
+  helperDetails.clientLroOverload = getClientLroOverload(paths);
   const urlInfo = transformUrlInfo(program, dpgContext);
   const apiVersionInfo = transformApiVersionInfo(
     client,
@@ -98,7 +106,7 @@ export async function transformRLCModel(
     importSet,
     apiVersionInfo,
     parameters,
-    annotations,
+    helperDetails,
     urlInfo
   };
 }
@@ -121,11 +129,18 @@ export function transformUrlInfo(
         const property = host?.[0]?.parameters.get(key);
         const type = property?.type;
 
-        if (!type) {
+        if (!property || !type) {
           continue;
         }
 
-        const schema = getSchemaForType(program, type);
+        const schema = getSchemaForType(
+          program,
+          dpgContext,
+          type,
+          [SchemaContext.Exception, SchemaContext.Input],
+          false,
+          property!
+        );
         urlParameters.push({
           name: key,
           type: getTypeName(schema),

package/src/transform/transformApiVersionInfo.ts

@@ -10,7 +10,8 @@ import {
   ApiVersionInfo,
   UrlInfo,
   extractPathApiVersion,
-  extractDefinedPosition
+  extractDefinedPosition,
+  SchemaContext
 } from "@azure-tools/rlc-common";
 import { getHttpOperation } from "@typespec/http";
 import {
@@ -71,7 +72,14 @@ function getOperationQueryApiVersion(
         (p) => p.type === "query" && isApiVersion(dpgContext, p)
       );
       params.map((p) => {
-        const type = getSchemaForType(program, p.param.type);
+        const type = getSchemaForType(
+          program,
+          dpgContext,
+          p.param.type,
+          [SchemaContext.Exception, SchemaContext.Input],
+          false,
+          p.param
+        );
         const typeString = JSON.stringify(trimUsage(type));
         apiVersionTypes.add(typeString);
       });
@@ -87,7 +95,14 @@ function getOperationQueryApiVersion(
       (p) => p.type === "query" && isApiVersion(dpgContext, p)
     );
     params.map((p) => {
-      const type = getSchemaForType(program, p.param.type);
+      const type = getSchemaForType(
+        program,
+        dpgContext,
+        p.param.type,
+        [SchemaContext.Exception, SchemaContext.Input],
+        false,
+        p.param
+      );
       const typeString = JSON.stringify(trimUsage(type));
       apiVersionTypes.add(typeString);
     });

package/src/transform/{transformAnnotationDetails.ts → transformHelperFunctionDetails.ts}

@@ -5,7 +5,7 @@ import {
   listOperationGroups,
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
-import { AnnotationDetails } from "@azure-tools/rlc-common";
+import { HelperFunctionDetails } from "@azure-tools/rlc-common";
 import { ignoreDiagnostics, Model, Program, Type } from "@typespec/compiler";
 import { getHttpOperation, HttpOperation } from "@typespec/http";
 import {
@@ -15,11 +15,11 @@ import {
 } from "../operationUtil.js";
 import { getSpecialSerializeInfo } from "./transformParameters.js";
 
-export function transformAnnotationDetails(
+export function transformHelperFunctionDetails(
   program: Program,
   client: SdkClient,
   dpgContext: SdkContext
-): AnnotationDetails | undefined {
+): HelperFunctionDetails {
   // Extract paged metadata from Azure.Core.Page
   const annotationDetails = {
     hasLongRunning: hasPollingOperations(program, client, dpgContext)

package/src/transform/transformParameters.ts

@@ -84,13 +84,18 @@ export function transformToParameterTypes(
     // transform path param
     const pathParams = transformPathParameters();
     // transform header param includeing content-type
-    const headerParams = transformHeaderParameters(program, parameters);
+    const headerParams = transformHeaderParameters(
+      program,
+      dpgContext,
+      parameters
+    );
     // transform body
     const bodyType = getBodyType(program, route);
     let bodyParameter = undefined;
     if (bodyType) {
       bodyParameter = transformBodyParameters(
         program,
+        dpgContext,
         parameters,
         headerParams,
         outputImportedSet,
@@ -108,13 +113,18 @@ export function transformToParameterTypes(
 
 function getParameterMetadata(
   program: Program,
+  dpgContext: SdkContext,
   paramType: "query" | "path" | "header",
   parameter: HttpOperationParameter
 ): ParameterMetadata {
-  const schema = getSchemaForType(program, parameter.param.type, [
-    SchemaContext.Input,
-    SchemaContext.Exception
-  ]) as Schema;
+  const schema = getSchemaForType(
+    program,
+    dpgContext,
+    parameter.param.type,
+    [SchemaContext.Exception, SchemaContext.Input],
+    false,
+    parameter.param
+  ) as Schema;
   let type = getTypeName(schema);
   const name = getParameterName(parameter.name);
   let description =
@@ -175,7 +185,7 @@ function transformQueryParameters(
     return [];
   }
   return queryParameters.map((qp) =>
-    getParameterMetadata(program, "query", qp)
+    getParameterMetadata(program, dpgContext, "query", qp)
   );
 }
 
@@ -191,6 +201,7 @@ function transformPathParameters() {
 
 function transformHeaderParameters(
   program: Program,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters
 ): ParameterMetadata[] {
   const headerParameters = parameters.parameters.filter(
@@ -200,12 +211,13 @@ function transformHeaderParameters(
     return [];
   }
   return headerParameters.map((qp) =>
-    getParameterMetadata(program, "header", qp)
+    getParameterMetadata(program, dpgContext, "header", qp)
   );
 }
 
 function transformBodyParameters(
   program: Program,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters,
   headers: ParameterMetadata[],
   importedModels: Set<string>,
@@ -224,6 +236,7 @@ function transformBodyParameters(
     // Case 1: Handle the normal case without binary or form data
     return transformNormalBody(
       program,
+      dpgContext,
       bodyType,
       parameters,
       importedModels,
@@ -236,6 +249,7 @@ function transformBodyParameters(
     // Case 3: Handle the form data
     return transformMultiFormBody(
       program,
+      dpgContext,
       bodyType,
       parameters,
       importedModels
@@ -245,6 +259,7 @@ function transformBodyParameters(
 
 function transformNormalBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>,
@@ -252,16 +267,18 @@ function transformNormalBody(
 ) {
   const description = extractDescriptionsFromBody(
     program,
+    dpgContext,
     bodyType,
     parameters
   ).join("\n\n");
   const type = extractNameFromCadlType(
     program,
+    dpgContext,
     bodyType,
     importedModels,
     headers
   );
-  const schema = getSchemaForType(program, bodyType);
+  const schema = getSchemaForType(program, dpgContext, bodyType);
   return {
     isPartialBody: false,
     body: [
@@ -304,6 +321,7 @@ function transformBinaryBody(
 
 function transformMultiFormBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>
@@ -311,9 +329,15 @@ function transformMultiFormBody(
   const isModelBody = bodyType.kind === "Model";
 
   if (!isModelBody) {
-    const type = extractNameFromCadlType(program, bodyType, importedModels);
+    const type = extractNameFromCadlType(
+      program,
+      dpgContext,
+      bodyType,
+      importedModels
+    );
     const description = extractDescriptionsFromBody(
       program,
+      dpgContext,
       bodyType,
       parameters
     ).join("\n\n");
@@ -338,10 +362,14 @@ function transformMultiFormBody(
 
   for (const [paramName, paramType] of bodyType.properties) {
     let type: string;
-    const bodySchema = getSchemaForType(program, paramType.type, [
-      SchemaContext.Input,
-      SchemaContext.Exception
-    ]) as any;
+    const bodySchema = getSchemaForType(
+      program,
+      dpgContext,
+      paramType.type,
+      [SchemaContext.Exception, SchemaContext.Input],
+      false,
+      paramType
+    ) as any;
     if (bodySchema?.format === "byte") {
       type = getBinaryType([SchemaContext.Input, SchemaContext.Exception]);
     } else if (bodySchema?.items?.format === "byte") {
@@ -350,7 +378,12 @@ function transformMultiFormBody(
         SchemaContext.Exception
       ])}>`;
     } else {
-      type = extractNameFromCadlType(program, paramType.type, importedModels);
+      type = extractNameFromCadlType(
+        program,
+        dpgContext,
+        paramType.type,
+        importedModels
+      );
     }
     bodyParameters.body!.push({
       name: paramName,
@@ -375,11 +408,12 @@ function getBodyDetail(bodyType: Type, headers: ParameterMetadata[]) {
 
 function extractNameFromCadlType(
   program: Program,
+  dpgContext: SdkContext,
   cadlType: Type,
   importedModels: Set<string>,
   headers?: ParameterMetadata[]
 ) {
-  const bodySchema = getSchemaForType(program, cadlType, [
+  const bodySchema = getSchemaForType(program, dpgContext, cadlType, [
     SchemaContext.Input,
     SchemaContext.Exception
   ]) as Schema;
@@ -437,6 +471,7 @@ function generateAnomymousModelSigniture(
 
 function extractDescriptionsFromBody(
   program: Program,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters
 ) {
@@ -445,7 +480,7 @@ function extractDescriptionsFromBody(
     getFormattedPropertyDoc(
       program,
       parameters.bodyParameter,
-      getSchemaForType(program, bodyType, [
+      getSchemaForType(program, dpgContext, bodyType, [
         SchemaContext.Input,
         SchemaContext.Exception
       ])
@@ -455,9 +490,9 @@ function extractDescriptionsFromBody(
 
 export function getSpecialSerializeInfo(parameter: HttpOperationParameter) {
   let hasMultiCollection = false;
-  const hasPipeCollection = false;
-  const hasSsvCollection = false;
-  const hasTsvCollection = false;
+  let hasPipeCollection = false;
+  let hasSsvCollection = false;
+  let hasTsvCollection = false;
   const descriptions = [];
   const collectionInfo = [];
   if (
@@ -468,7 +503,23 @@ export function getSpecialSerializeInfo(parameter: HttpOperationParameter) {
     descriptions.push("buildMultiCollection");
     collectionInfo.push("multi");
   }
-  // TODO add other collection logic once cadl has supported it.
+  if (parameter.type === "query" && (parameter as any).format === "ssv") {
+    hasSsvCollection = true;
+    descriptions.push("buildSsvCollection");
+    collectionInfo.push("ssv");
+  }
+
+  if (parameter.type === "query" && (parameter as any).format === "tsv") {
+    hasTsvCollection = true;
+    descriptions.push("buildTsvCollection");
+    collectionInfo.push("tsv");
+  }
+
+  if (parameter.type === "query" && (parameter as any).format === "pipes") {
+    hasPipeCollection = true;
+    descriptions.push("buildPipeCollection");
+    collectionInfo.push("pipe");
+  }
   return {
     hasMultiCollection,
     hasPipeCollection,

package/src/transform/transformPaths.ts

@@ -26,11 +26,11 @@ import {
 } from "@azure-tools/typespec-client-generator-core";
 import { getSchemaForType } from "../modelUtils.js";
 import {
+  extractOperationLroDetail,
   getOperationGroupName,
   getOperationStatuscode,
   isDefaultStatusCode,
   isDefinedStatusCode,
-  isLongRunningOperation,
   isPagingOperation
 } from "../operationUtil.js";
 
@@ -48,13 +48,13 @@ export function transformPaths(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
-      transformOperation(program, route, paths, dpgContext, operationGroup);
+      transformOperation(program, dpgContext, route, paths, operationGroup);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
-    transformOperation(program, route, paths, dpgContext);
+    transformOperation(program, dpgContext, route, paths);
   }
   return paths;
 }
@@ -97,33 +97,38 @@ function getResponseTypes(
 
 function transformOperation(
   program: Program,
+  dpgContext: SdkContext,
   route: HttpOperation,
   paths: Paths,
-  dpgContext: SdkContext,
+
   operationGroup?: SdkOperationGroup
 ) {
   const respNames = [];
+  const operationGroupName = getOperationGroupName(operationGroup);
   for (const resp of route.responses) {
     const respName = getResponseTypeName(
-      getOperationGroupName(operationGroup),
+      operationGroupName,
       route.operation.name,
       getOperationStatuscode(resp)
     );
     respNames.push(respName);
   }
+  const responseTypes = getResponseTypes(route, operationGroup);
   const method: OperationMethod = {
     description: getDoc(program, route.operation) ?? "",
     hasOptionalOptions: !hasRequiredOptions(dpgContext, route.parameters),
-    optionsName: getParameterTypeName(
-      getOperationGroupName(operationGroup),
-      route.operation.name
-    ),
-    responseTypes: getResponseTypes(route, operationGroup),
+    optionsName: getParameterTypeName(operationGroupName, route.operation.name),
+    responseTypes,
     returnType: respNames.join(" | "),
     successStatus: gerOperationSuccessStatus(route),
     operationName: route.operation.name,
-    annotations: {
-      isLongRunning: isLongRunningOperation(program, route),
+    operationHelperDetail: {
+      lroDetails: extractOperationLroDetail(
+        program,
+        route,
+        responseTypes,
+        operationGroupName
+      ),
       isPageable: isPagingOperation(program, route)
     }
   };
@@ -137,15 +142,19 @@ function transformOperation(
   } else {
     paths[route.path] = {
       description: getDoc(program, route.operation) ?? "",
-      name: route.operation.name || "Client",
+      name: escapeCoreName(route.operation.name || "Client"),
       pathParameters: route.parameters.parameters
         .filter((p) => p.type === "path")
         .map((p) => {
           return {
             name: p.name,
             type: p.param.sourceProperty
-              ? getSchemaForType(program, p.param.sourceProperty?.type).type
-              : getSchemaForType(program, p.param.type).type,
+              ? getSchemaForType(
+                  program,
+                  dpgContext,
+                  p.param.sourceProperty?.type
+                ).type
+              : getSchemaForType(program, dpgContext, p.param.type).type,
             description: getDoc(program, p.param)
           };
         }),
@@ -157,6 +166,12 @@ function transformOperation(
   }
 }
 
+function escapeCoreName(name: string) {
+  if (["client", "streamablemethod"].indexOf(name.toLowerCase()) > -1) {
+    return "_" + name;
+  }
+  return name;
+}
 function hasRequiredOptions(
   dpgContext: SdkContext,
   routeParameters: HttpOperationParameters

package/src/transform/transformResponses.ts

@@ -14,7 +14,8 @@ import {
   OperationResponse,
   ResponseMetadata,
   Schema,
-  SchemaContext
+  SchemaContext,
+  getLroLogicalResponseName
 } from "@azure-tools/rlc-common";
 import { Program, getDoc, ignoreDiagnostics } from "@typespec/compiler";
 import {
@@ -31,7 +32,8 @@ import {
 import {
   getOperationGroupName,
   getOperationStatuscode,
-  isBinaryPayload
+  isBinaryPayload,
+  getOperationLroOverload
 } from "../operationUtil.js";
 
 export function transformToResponseTypes(
@@ -77,15 +79,24 @@ export function transformToResponseTypes(
         description: resp.description
       };
       // transform header
-      const headers = transformHeaders(program, resp);
+      const headers = transformHeaders(program, dpgContext, resp);
       // transform body
-      const body = transformBody(program, resp, inputImportedSet);
+      const body = transformBody(program, dpgContext, resp, inputImportedSet);
       rlcOperationUnit.responses.push({
         ...rlcResponseUnit,
         headers,
         body
       });
     }
+    const lroLogicalResponse = transformLroLogicalResponse(
+      program,
+      route,
+      getOperationGroupName(operationGroup),
+      rlcOperationUnit.responses
+    );
+    if (lroLogicalResponse) {
+      rlcOperationUnit.responses.push(lroLogicalResponse);
+    }
     rlcResponses.push(rlcOperationUnit);
   }
   return rlcResponses;
@@ -99,6 +110,7 @@ export function transformToResponseTypes(
  */
 function transformHeaders(
   program: Program,
+  dpgContext: SdkContext,
   response: HttpOperationResponse
 ): ResponseHeaderSchema[] | undefined {
   if (!response.responses.length) {
@@ -120,7 +132,7 @@ function transformHeaders(
       if (!value) {
         continue;
       }
-      const typeSchema = getSchemaForType(program, value!.type, [
+      const typeSchema = getSchemaForType(program, dpgContext, value!.type, [
         SchemaContext.Output
       ]) as Schema;
       const type = getTypeName(typeSchema);
@@ -139,6 +151,7 @@ function transformHeaders(
 
 function transformBody(
   program: Program,
+  dpgContext: SdkContext,
   response: HttpOperationResponse,
   importedModels: Set<string>
 ) {
@@ -163,7 +176,7 @@ function transformBody(
       descriptions.add("Value may contain any sequence of octets");
       continue;
     }
-    const bodySchema = getSchemaForType(program, body!.type, [
+    const bodySchema = getSchemaForType(program, dpgContext, body!.type, [
       SchemaContext.Output
     ]) as Schema;
     if (bodySchema.fromCore) {
@@ -188,3 +201,34 @@ function transformBody(
     fromCore
   };
 }
+
+function transformLroLogicalResponse(
+  program: Program,
+  route: HttpOperation,
+  operationGroupName: string,
+  existingResponses: ResponseMetadata[]
+): ResponseMetadata | undefined {
+  const operationLroOverload = getOperationLroOverload(
+    program,
+    route,
+    undefined,
+    existingResponses
+  );
+  if (!operationLroOverload) {
+    return;
+  }
+  const sortedResponses = existingResponses
+    .filter((r) => r.statusCode.startsWith("20"))
+    .sort((r1, r2) => (r1.statusCode > r2.statusCode ? -1 : 1));
+  const successResp = sortedResponses[0];
+  const logicalLROResponse: ResponseMetadata = {
+    statusCode: "200",
+    description: `The final response for long-running ${route.operation.name} operation`,
+    predefinedName: getLroLogicalResponseName(
+      operationGroupName,
+      route.operation.name
+    ),
+    body: successResp?.body
+  };
+  return logicalLROResponse;
+}

package/src/transform/transformSchemas.ts

@@ -68,7 +68,7 @@ export function transformSchemas(
     }
   }
   program.stateMap(modelKey).forEach((context, cadlModel) => {
-    const model = getSchemaForType(program, cadlModel, context);
+    const model = getSchemaForType(program, dpgContext, cadlModel, context);
     if (model) {
       model.usage = context;
     }