@azure-tools/typespec-ts 0.11.0 → 0.12.0-alpha.20230501.1

package/src/transform/transformApiVersionInfo.ts

@@ -0,0 +1,108 @@
+import {
+  SdkClient,
+  SdkContext,
+  isApiVersion,
+  listOperationGroups,
+  listOperationsInOperationGroup
+} from "@azure-tools/typespec-client-generator-core";
+import { ignoreDiagnostics, Program } from "@typespec/compiler";
+import {
+  ApiVersionInfo,
+  UrlInfo,
+  extractPathApiVersion,
+  extractDefinedPosition
+} from "@azure-tools/rlc-common";
+import { getHttpOperation } from "@typespec/http";
+import {
+  getEnrichedDefaultApiVersion,
+  getSchemaForType,
+  trimUsage
+} from "../modelUtils.js";
+
+export function transformApiVersionInfo(
+  client: SdkClient,
+  program: Program,
+  dpgContext: SdkContext,
+  urlInfo?: UrlInfo
+): ApiVersionInfo | undefined {
+  const queryVersionDetail = getOperationQueryApiVersion(
+    client,
+    program,
+    dpgContext
+  );
+  const pathVersionDetail = extractPathApiVersion(urlInfo);
+  const isCrossedVersion =
+    pathVersionDetail?.isCrossedVersion || queryVersionDetail?.isCrossedVersion;
+  let defaultValue =
+    getEnrichedDefaultApiVersion(program, dpgContext) ??
+    pathVersionDetail?.defaultValue ??
+    queryVersionDetail?.defaultValue;
+
+  // Clear the default value if there exists cross version
+  if (isCrossedVersion) {
+    defaultValue = undefined;
+  }
+
+  return {
+    definedPosition: extractDefinedPosition(
+      queryVersionDetail,
+      pathVersionDetail
+    ),
+    isCrossedVersion,
+    defaultValue
+  };
+}
+
+function getOperationQueryApiVersion(
+  client: SdkClient,
+  program: Program,
+  dpgContext: SdkContext
+): ApiVersionInfo | undefined {
+  const operationGroups = listOperationGroups(dpgContext, client);
+  const apiVersionTypes = new Set<string>();
+  for (const operationGroup of operationGroups) {
+    const operations = listOperationsInOperationGroup(
+      dpgContext,
+      operationGroup
+    );
+    for (const op of operations) {
+      const route = ignoreDiagnostics(getHttpOperation(program, op));
+      const params = route.parameters.parameters.filter(
+        (p) => p.type === "query" && isApiVersion(dpgContext, p)
+      );
+      params.map((p) => {
+        const type = getSchemaForType(program, p.param.type);
+        const typeString = JSON.stringify(trimUsage(type));
+        apiVersionTypes.add(typeString);
+      });
+      if (apiVersionTypes.size > 1) {
+        break;
+      }
+    }
+  }
+  const clientOperations = listOperationsInOperationGroup(dpgContext, client);
+  for (const clientOp of clientOperations) {
+    const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    const params = route.parameters.parameters.filter(
+      (p) => p.type === "query" && isApiVersion(dpgContext, p)
+    );
+    params.map((p) => {
+      const type = getSchemaForType(program, p.param.type);
+      const typeString = JSON.stringify(trimUsage(type));
+      apiVersionTypes.add(typeString);
+    });
+    if (apiVersionTypes.size > 1) {
+      break;
+    }
+  }
+  // If no api-version parameter defined return directly
+  if (apiVersionTypes.size === 0) {
+    return;
+  }
+  const detail: ApiVersionInfo = {
+    definedPosition: "query",
+    isCrossedVersion: apiVersionTypes.size > 1,
+    defaultValue: undefined // We won't prompt the query versions into client one
+  };
+  return detail;
+}

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

@@ -1,11 +1,11 @@
 import { PagedResultMetadata } from "@azure-tools/typespec-azure-core";
 import {
-  Client,
-  DpgContext,
+  SdkClient,
+  SdkContext,
   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: Client,
-  dpgContext: DpgContext
-): AnnotationDetails | undefined {
+  client: SdkClient,
+  dpgContext: SdkContext
+): HelperFunctionDetails {
   // Extract paged metadata from Azure.Core.Page
   const annotationDetails = {
     hasLongRunning: hasPollingOperations(program, client, dpgContext)
@@ -93,8 +93,8 @@ export function getPageable(
 
 function extractPageDetailFromCore(
   program: Program,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ) {
   if (!hasPagingOperations(program, client, dpgContext)) {
     return;
@@ -171,8 +171,8 @@ function parseItemName(paged: PagedResultMetadata): string | undefined {
 
 function extractSpecialSerializeInfo(
   program: Program,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ) {
   let hasMultiCollection = false;
   let hasPipeCollection = false;

package/src/transform/transformParameters.ts

@@ -23,25 +23,25 @@ import {
   getSchemaForType,
   getBinaryType,
   getFormattedPropertyDoc,
-  getBodyType
+  getBodyType,
+  predictDefaultValue
 } from "../modelUtils.js";
 
 import { getOperationGroupName, isBinaryPayload } from "../operationUtil.js";
 import {
-  Client,
-  DpgContext,
+  SdkClient,
+  SdkContext,
   listOperationGroups,
   listOperationsInOperationGroup,
-  OperationGroup,
+  SdkOperationGroup,
   isApiVersion
 } from "@azure-tools/typespec-client-generator-core";
-import { getDefaultValue } from "./transform.js";
 
 export function transformToParameterTypes(
   program: Program,
   importDetails: Map<ImportKind, Set<string>>,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ): OperationParameter[] {
   const operationGroups = listOperationGroups(dpgContext, client);
   const rlcParameters: OperationParameter[] = [];
@@ -67,7 +67,7 @@ export function transformToParameterTypes(
   function transformToParameterTypesForRoute(
     program: Program,
     route: HttpOperation,
-    operationGroup?: OperationGroup
+    operationGroup?: SdkOperationGroup
   ) {
     const parameters = route.parameters;
     const rlcParameter: OperationParameter = {
@@ -160,7 +160,7 @@ function getParameterName(name: string) {
 
 function transformQueryParameters(
   program: Program,
-  dpgContext: DpgContext,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters
 ): ParameterMetadata[] {
   const queryParameters = parameters.parameters.filter(
@@ -168,7 +168,7 @@ function transformQueryParameters(
       p.type === "query" &&
       !(
         isApiVersion(dpgContext, p) &&
-        getDefaultValue(program, dpgContext, p.param)
+        predictDefaultValue(program, dpgContext, p.param)
       )
   );
   if (!queryParameters.length) {
@@ -455,9 +455,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 +468,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

@@ -17,27 +17,27 @@ import {
   HttpOperationResponse
 } from "@typespec/http";
 import {
-  Client,
-  DpgContext,
+  SdkClient,
+  SdkContext,
   listOperationGroups,
   listOperationsInOperationGroup,
-  OperationGroup,
+  SdkOperationGroup,
   isApiVersion
 } from "@azure-tools/typespec-client-generator-core";
 import { getSchemaForType } from "../modelUtils.js";
 import {
+  extractOperationLroDetail,
   getOperationGroupName,
   getOperationStatuscode,
   isDefaultStatusCode,
   isDefinedStatusCode,
-  isLongRunningOperation,
   isPagingOperation
 } from "../operationUtil.js";
 
 export function transformPaths(
   program: Program,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ): Paths {
   const operationGroups = listOperationGroups(dpgContext, client);
   const paths: Paths = {};
@@ -65,7 +65,7 @@ export function transformPaths(
  */
 function getResponseTypes(
   operation: HttpOperation,
-  operationGroup?: OperationGroup
+  operationGroup?: SdkOperationGroup
 ): ResponseTypes {
   const returnTypes: ResponseTypes = {
     error: [],
@@ -99,31 +99,35 @@ function transformOperation(
   program: Program,
   route: HttpOperation,
   paths: Paths,
-  dpgContext: DpgContext,
-  operationGroup?: OperationGroup
+  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,7 +141,7 @@ 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) => {
@@ -157,8 +161,14 @@ function transformOperation(
   }
 }
 
+function escapeCoreName(name: string) {
+  if (["client", "streamablemethod"].indexOf(name.toLowerCase()) > -1) {
+    return "_" + name;
+  }
+  return name;
+}
 function hasRequiredOptions(
-  dpgContext: DpgContext,
+  dpgContext: SdkContext,
   routeParameters: HttpOperationParameters
 ) {
   const isRequiredBodyParam = routeParameters.bodyParameter?.optional === false;

package/src/transform/transformResponses.ts

@@ -2,11 +2,11 @@
 // Licensed under the MIT License.
 
 import {
-  Client,
-  DpgContext,
+  SdkClient,
+  SdkContext,
   listOperationGroups,
   listOperationsInOperationGroup,
-  OperationGroup
+  SdkOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
 import {
   ResponseHeaderSchema,
@@ -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,14 +32,15 @@ import {
 import {
   getOperationGroupName,
   getOperationStatuscode,
-  isBinaryPayload
+  isBinaryPayload,
+  getOperationLroOverload
 } from "../operationUtil.js";
 
 export function transformToResponseTypes(
   program: Program,
   importDetails: Map<ImportKind, Set<string>>,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ): OperationResponse[] {
   const operationGroups = listOperationGroups(dpgContext, client);
   const rlcResponses: OperationResponse[] = [];
@@ -63,7 +65,7 @@ export function transformToResponseTypes(
   }
   function transformToResponseTypesForRoute(
     route: HttpOperation,
-    operationGroup?: OperationGroup
+    operationGroup?: SdkOperationGroup
   ) {
     const rlcOperationUnit: OperationResponse = {
       operationGroup: getOperationGroupName(operationGroup),
@@ -86,6 +88,15 @@ export function transformToResponseTypes(
         body
       });
     }
+    const lroLogicalResponse = transformLroLogicalResponse(
+      program,
+      route,
+      getOperationGroupName(operationGroup),
+      rlcOperationUnit.responses
+    );
+    if (lroLogicalResponse) {
+      rlcOperationUnit.responses.push(lroLogicalResponse);
+    }
     rlcResponses.push(rlcOperationUnit);
   }
   return rlcResponses;
@@ -188,3 +199,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

@@ -2,8 +2,8 @@
 // Licensed under the MIT License.
 
 import {
-  Client,
-  DpgContext,
+  SdkClient,
+  SdkContext,
   listOperationGroups,
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
@@ -13,13 +13,14 @@ import { getHttpOperation, HttpOperation } from "@typespec/http";
 import {
   getSchemaForType,
   includeDerivedModel,
-  getBodyType
+  getBodyType,
+  trimUsage
 } from "../modelUtils.js";
 
 export function transformSchemas(
   program: Program,
-  client: Client,
-  dpgContext: DpgContext
+  client: SdkClient,
+  dpgContext: SdkContext
 ) {
   const schemas: Map<string, SchemaContext[]> = new Map<
     string,
@@ -82,20 +83,7 @@ export function transformSchemas(
     }
     schemas.set(pureModel, usage);
   });
-  function trimUsage(model: any) {
-    if (typeof model !== "object") {
-      return model;
-    }
-    const tmpModel = Object.assign({}, model);
-    const tmpModelKeys = Object.keys(tmpModel).filter((item) => {
-      return item !== "usage";
-    });
-    const ordered = tmpModelKeys.sort().reduce((obj, key) => {
-      (obj as any)[key] = trimUsage(tmpModel[key]);
-      return obj;
-    }, {});
-    return ordered;
-  }
+
   function setModelMap(type: Type, schemaContext: SchemaContext) {
     if (program.stateMap(modelKey).get(type)) {
       const context = program.stateMap(modelKey).get(type);
@@ -109,15 +97,19 @@ export function transformSchemas(
   }
   function getGeneratedModels(model: Type, context: SchemaContext) {
     if (model.kind === "Model") {
-      if (model.templateArguments && model.templateArguments.length > 0) {
-        for (const temp of model.templateArguments) {
-          if (
-            !program.stateMap(modelKey).get(temp) ||
-            !program.stateMap(modelKey).get(temp)?.includes(context)
-          ) {
-            getGeneratedModels(temp, context);
-            break;
-          }
+      if (
+        model.templateMapper &&
+        model.templateMapper.args &&
+        model.templateMapper.args.length > 0
+      ) {
+        const temp = model.templateMapper.args[0];
+        if (
+          temp &&
+          temp.kind === "Model" &&
+          (!program.stateMap(modelKey).get(temp) ||
+            !program.stateMap(modelKey).get(temp)?.includes(context))
+        ) {
+          getGeneratedModels(temp, context);
         }
       }
 

package/src/transform/transfromRLCOptions.ts

@@ -1,5 +1,5 @@
 import {
-  DpgContext,
+  SdkContext,
   listClients
 } from "@azure-tools/typespec-client-generator-core";
 import {
@@ -11,14 +11,14 @@ import {
 } from "@azure-tools/rlc-common";
 import { getDoc, NoTarget, Program } from "@typespec/compiler";
 import { getAuthentication } from "@typespec/http";
-import { getDefaultService } from "./transform.js";
 import { reportDiagnostic } from "../lib.js";
+import { getDefaultService } from "../modelUtils.js";
 
 export function transformRLCOptions(
   program: Program,
   emitterOptions: RLCOptions,
   emitterOutputDir: string,
-  dpgContext: DpgContext
+  dpgContext: SdkContext
 ): RLCOptions {
   // Extract the options from emitter option
   const options = extractRLCOptions(program, emitterOptions, emitterOutputDir);