@azure-tools/typespec-ts 0.14.0 → 0.15.0-alpha.20230822.1

package/src/transform/transform.ts

@@ -1,10 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import {
-  SdkClient,
-  SdkContext
-} from "@azure-tools/typespec-client-generator-core";
+import { SdkClient } from "@azure-tools/typespec-client-generator-core";
 import {
   ImportKind,
   NameType,
@@ -19,7 +16,7 @@ import {
   SchemaContext,
   UrlInfo
 } from "@azure-tools/rlc-common";
-import { Program, getDoc } from "@typespec/compiler";
+import { getDoc } from "@typespec/compiler";
 import { getServers } from "@typespec/http";
 import { join } from "path";
 import {
@@ -34,32 +31,19 @@ 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 "../utils/operationUtil.js";
-
-export interface RLCSdkContext extends SdkContext {
-  options?: RLCOptions;
-}
+import { transformTelemetryInfo } from "./transformTelemetryInfo.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export async function transformRLCModel(
-  program: Program,
-  emitterOptions: RLCOptions,
   client: SdkClient,
-  emitterOutputDir: string,
-  dpgContext: RLCSdkContext
+  dpgContext: SdkContext
 ): Promise<RLCModel> {
-  const options: RLCOptions = transformRLCOptions(
-    emitterOptions,
-    emitterOutputDir,
-    dpgContext
-  );
-  dpgContext.options = options;
+  const program = dpgContext.program;
+  const options: RLCOptions = dpgContext.rlcOptions!;
   const srcPath = join(
-    emitterOutputDir ?? "",
-    "src",
-    // When generating modular library, RLC has to go under rest folder
-    options.isModularLibrary ? "rest" : "",
+    dpgContext.generationPathDetail?.rlcSourcesDir ?? "",
     options.batch && options.batch.length > 1
       ? normalizeName(client.name.replace("Client", ""), NameType.File)
       : ""
@@ -90,8 +74,9 @@ export async function transformRLCModel(
   const helperDetails = transformHelperFunctionDetails(client, dpgContext);
   // Enrich client-level annotation detail
   helperDetails.clientLroOverload = getClientLroOverload(paths);
-  const urlInfo = transformUrlInfo(program, dpgContext);
+  const urlInfo = transformUrlInfo(dpgContext);
   const apiVersionInfo = transformApiVersionInfo(client, dpgContext, urlInfo);
+  const telemetryOptions = transformTelemetryInfo(dpgContext, client);
   return {
     srcPath,
     libraryName,
@@ -103,14 +88,13 @@ export async function transformRLCModel(
     apiVersionInfo,
     parameters,
     helperDetails,
-    urlInfo
+    urlInfo,
+    telemetryOptions
   };
 }
 
-export function transformUrlInfo(
-  program: Program,
-  dpgContext: SdkContext
-): UrlInfo | undefined {
+export function transformUrlInfo(dpgContext: SdkContext): UrlInfo | undefined {
+  const program = dpgContext.program;
   const serviceNs = getDefaultService(program)?.type;
   let endpoint = undefined;
   const urlParameters: PathParameter[] = [];
@@ -137,7 +121,8 @@ export function transformUrlInfo(
           property!
         );
         urlParameters.push({
-          name: key,
+          oriName: key,
+          name: normalizeName(key, NameType.Parameter, true),
           type: getTypeName(schema),
           description:
             (getDoc(program, property) &&
@@ -148,6 +133,14 @@ export function transformUrlInfo(
       }
     }
   }
+  if (endpoint && urlParameters.length > 0) {
+    for (const param of urlParameters) {
+      if (param.oriName) {
+        const regexp = new RegExp(`{${param.oriName}}`, "g");
+        endpoint = endpoint.replace(regexp, `{${param.name}}`);
+      }
+    }
+  }
   // Set the default value if missing endpoint parameter
   if (endpoint == undefined && urlParameters.length === 0) {
     endpoint = "{endpoint}";

package/src/transform/transformApiVersionInfo.ts

@@ -1,6 +1,5 @@
 import {
   SdkClient,
-  SdkContext,
   isApiVersion,
   listOperationGroups,
   listOperationsInOperationGroup
@@ -19,6 +18,7 @@ import {
   getSchemaForType,
   trimUsage
 } from "../utils/modelUtils.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformApiVersionInfo(
   client: SdkClient,

package/src/transform/transformHelperFunctionDetails.ts

@@ -1,7 +1,6 @@
 import { PagedResultMetadata } from "@azure-tools/typespec-azure-core";
 import {
   SdkClient,
-  SdkContext,
   listOperationGroups,
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
@@ -11,9 +10,10 @@ import { getHttpOperation, HttpOperation } from "@typespec/http";
 import {
   hasPagingOperations,
   extractPagedMetadataNested,
-  hasPollingOperations
+  hasPollingOperations,
+  getSpecialSerializeInfo
 } from "../utils/operationUtil.js";
-import { getSpecialSerializeInfo } from "./transformParameters.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformHelperFunctionDetails(
   client: SdkClient,
@@ -168,12 +168,7 @@ function extractPageDetailFromCore(
 }
 
 function parseNextLinkName(paged: PagedResultMetadata): string | undefined {
-  const pathComponents = paged.nextLinkPath?.split(".");
-  if (pathComponents) {
-    // TODO: This logic breaks down if there actually is a dotted path.
-    return pathComponents[pathComponents.length - 1];
-  }
-  return undefined;
+  return paged.nextLinkProperty?.name;
 }
 
 function parseItemName(paged: PagedResultMetadata): string | undefined {
@@ -204,7 +199,10 @@ function extractSpecialSerializeInfo(
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
       route.parameters.parameters.forEach((parameter) => {
-        const serializeInfo = getSpecialSerializeInfo(parameter);
+        const serializeInfo = getSpecialSerializeInfo(
+          parameter.type,
+          (parameter as any).format
+        );
         hasMultiCollection = hasMultiCollection
           ? hasMultiCollection
           : serializeInfo.hasMultiCollection;
@@ -227,7 +225,10 @@ function extractSpecialSerializeInfo(
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
     route.parameters.parameters.forEach((parameter) => {
-      const serializeInfo = getSpecialSerializeInfo(parameter);
+      const serializeInfo = getSpecialSerializeInfo(
+        parameter.type,
+        (parameter as any).format
+      );
       hasMultiCollection = hasMultiCollection
         ? hasMultiCollection
         : serializeInfo.hasMultiCollection;

package/src/transform/transformParameters.ts

@@ -31,6 +31,7 @@ import {
 import {
   getOperationGroupName,
   getOperationName,
+  getSpecialSerializeInfo,
   isBinaryPayload
 } from "../utils/operationUtil.js";
 import {
@@ -39,12 +40,12 @@ import {
   listOperationsInOperationGroup,
   isApiVersion
 } from "@azure-tools/typespec-client-generator-core";
-import { RLCSdkContext } from "./transform.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformToParameterTypes(
   importDetails: Map<ImportKind, Set<string>>,
   client: SdkClient,
-  dpgContext: RLCSdkContext
+  dpgContext: SdkContext
 ): OperationParameter[] {
   const program = dpgContext.program;
   const operationGroups = listOperationGroups(dpgContext, client);
@@ -114,7 +115,7 @@ export function transformToParameterTypes(
 }
 
 function getParameterMetadata(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   paramType: "query" | "path" | "header",
   parameter: HttpOperationParameter
 ): ParameterMetadata {
@@ -140,7 +141,10 @@ function getParameterMetadata(
     type === "number[]" ||
     type === "Array<number>"
   ) {
-    const serializeInfo = getSpecialSerializeInfo(parameter);
+    const serializeInfo = getSpecialSerializeInfo(
+      parameter.type,
+      (parameter as any).format
+    );
     if (
       serializeInfo.hasMultiCollection ||
       serializeInfo.hasPipeCollection ||
@@ -180,7 +184,7 @@ function getParameterName(name: string) {
 }
 
 function transformQueryParameters(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters
 ): ParameterMetadata[] {
   const queryParameters = parameters.parameters.filter(
@@ -207,7 +211,7 @@ function transformPathParameters() {
 }
 
 function transformHeaderParameters(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters
 ): ParameterMetadata[] {
   const headerParameters = parameters.parameters.filter(
@@ -222,7 +226,7 @@ function transformHeaderParameters(
 }
 
 function transformBodyParameters(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   parameters: HttpOperationParameters,
   headers: ParameterMetadata[],
   importedModels: Set<string>,
@@ -264,7 +268,7 @@ function transformBodyParameters(
 }
 
 function transformNormalBody(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>,
@@ -307,7 +311,7 @@ function transformNormalBody(
 }
 
 function transformMultiFormBody(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>
@@ -374,7 +378,7 @@ function transformMultiFormBody(
 }
 
 function getBodyDetail(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   bodyType: Type,
   headers: ParameterMetadata[]
 ) {
@@ -389,7 +393,7 @@ function getBodyDetail(
 }
 
 function extractNameFromCadlType(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   cadlType: Type,
   importedModels: Set<string>,
   headers?: ParameterMetadata[]
@@ -402,7 +406,10 @@ function extractNameFromCadlType(
   if (importedNames) {
     importedNames.forEach(importedModels.add, importedModels);
   }
-  let typeName = getTypeName(bodySchema);
+  let typeName = getTypeName(bodySchema, [
+    SchemaContext.Input,
+    SchemaContext.Exception
+  ]);
   if (isAnonymousModel(bodySchema)) {
     // Handle anonymous Model
     return generateAnomymousModelSigniture(bodySchema, importedModels);
@@ -451,7 +458,7 @@ function generateAnomymousModelSigniture(
 }
 
 function extractDescriptionsFromBody(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   bodyType: Type,
   parameters: HttpOperationParameters
 ) {
@@ -467,53 +474,3 @@ function extractDescriptionsFromBody(
     );
   return description ? [description] : [];
 }
-
-export function getSpecialSerializeInfo(parameter: HttpOperationParameter) {
-  let hasMultiCollection = false;
-  let hasPipeCollection = false;
-  let hasSsvCollection = false;
-  let hasTsvCollection = false;
-  let hasCsvCollection = false;
-  const descriptions = [];
-  const collectionInfo = [];
-  if (
-    (parameter.type === "query" || parameter.type === "header") &&
-    (parameter as any).format === "multi"
-  ) {
-    hasMultiCollection = true;
-    descriptions.push("buildMultiCollection");
-    collectionInfo.push("multi");
-  }
-  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");
-  }
-
-  if (parameter.type === "header" && (parameter as any).format === "csv") {
-    hasCsvCollection = true;
-    descriptions.push("buildCsvCollection");
-    collectionInfo.push("csv");
-  }
-  return {
-    hasMultiCollection,
-    hasPipeCollection,
-    hasSsvCollection,
-    hasTsvCollection,
-    hasCsvCollection,
-    descriptions,
-    collectionInfo
-  };
-}

package/src/transform/transformPaths.ts

@@ -32,12 +32,12 @@ import {
   isDefinedStatusCode,
   isPagingOperation
 } from "../utils/operationUtil.js";
-import { RLCSdkContext } from "./transform.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformPaths(
   program: Program,
   client: SdkClient,
-  dpgContext: RLCSdkContext
+  dpgContext: SdkContext
 ): Paths {
   const operationGroups = listOperationGroups(dpgContext, client);
   const paths: Paths = {};
@@ -72,7 +72,7 @@ export function transformPaths(
  * an operation can end up returning.
  */
 function getResponseTypes(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   operation: HttpOperation
 ): ResponseTypes {
   const returnTypes: ResponseTypes = {
@@ -104,7 +104,7 @@ function getResponseTypes(
 }
 
 function transformOperation(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   route: HttpOperation,
   paths: Paths
 ) {
@@ -180,7 +180,7 @@ function escapeCoreName(name: string) {
   return name;
 }
 function hasRequiredOptions(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   routeParameters: HttpOperationParameters
 ) {
   const isRequiredBodyParam = routeParameters.bodyParameter?.optional === false;

package/src/transform/transformResponses.ts

@@ -34,12 +34,12 @@ import {
   getOperationLroOverload,
   getOperationName
 } from "../utils/operationUtil.js";
-import { RLCSdkContext } from "./transform.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformToResponseTypes(
   importDetails: Map<ImportKind, Set<string>>,
   client: SdkClient,
-  dpgContext: RLCSdkContext
+  dpgContext: SdkContext
 ): OperationResponse[] {
   const program = dpgContext.program;
   const operationGroups = listOperationGroups(dpgContext, client);
@@ -114,7 +114,7 @@ export function transformToResponseTypes(
  * @returns rlc header shcema
  */
 function transformHeaders(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   response: HttpOperationResponse
 ): ResponseHeaderSchema[] | undefined {
   if (!response.responses.length) {
@@ -154,7 +154,7 @@ function transformHeaders(
 }
 
 function transformBody(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   response: HttpOperationResponse,
   importedModels: Set<string>
 ) {
@@ -188,7 +188,11 @@ function transformBody(
     const bodyType = getTypeName(bodySchema);
     const importedNames = getImportedModelName(bodySchema);
     if (importedNames) {
-      importedNames.forEach(importedModels.add, importedModels);
+      importedNames
+        .filter((name) => {
+          return name !== "any";
+        })
+        .forEach(importedModels.add, importedModels);
     }
     typeSet.add(bodyType);
   }
@@ -206,7 +210,7 @@ function transformBody(
 }
 
 function transformLroLogicalResponse(
-  dpgContext: RLCSdkContext,
+  dpgContext: SdkContext,
   route: HttpOperation,
   operationGroupName: string,
   existingResponses: ResponseMetadata[]

package/src/transform/transformSchemas.ts

@@ -15,12 +15,12 @@ import {
   getBodyType,
   trimUsage
 } from "../utils/modelUtils.js";
-import { RLCSdkContext } from "./transform.js";
+import { SdkContext } from "../utils/interfaces.js";
 
 export function transformSchemas(
   program: Program,
   client: SdkClient,
-  dpgContext: RLCSdkContext
+  dpgContext: SdkContext
 ) {
   const schemas: Map<string, SchemaContext[]> = new Map<
     string,

package/src/transform/transformTelemetryInfo.ts

@@ -0,0 +1,72 @@
+import { TelemetryInfo } from "@azure-tools/rlc-common";
+import {
+  SdkClient,
+  SdkContext,
+  listOperationGroups,
+  listOperationsInOperationGroup
+} from "@azure-tools/typespec-client-generator-core";
+import { ignoreDiagnostics } from "@typespec/compiler";
+import { getHttpOperation, HttpOperation } from "@typespec/http";
+
+export function transformTelemetryInfo(
+  dpgContext: SdkContext,
+  client: SdkClient
+): TelemetryInfo | undefined {
+  const customRequestIdHeaderName = getCustomRequestHeaderNameForClient(
+    dpgContext,
+    client
+  );
+  if (customRequestIdHeaderName) {
+    return {
+      customRequestIdHeaderName
+    };
+  }
+  return undefined;
+}
+
+function getCustomRequestHeaderNameForClient(
+  dpgContext: SdkContext,
+  client: SdkClient
+) {
+  const program = dpgContext.program;
+  const operationGroups = listOperationGroups(dpgContext, client);
+  for (const operationGroup of operationGroups) {
+    const operations = listOperationsInOperationGroup(
+      dpgContext,
+      operationGroup
+    );
+    for (const op of operations) {
+      const headerName = getCustomRequestHeaderNameForOperation(
+        ignoreDiagnostics(getHttpOperation(program, op))
+      );
+      if (headerName != undefined) {
+        return headerName;
+      }
+    }
+  }
+  const clientOperations = listOperationsInOperationGroup(dpgContext, client);
+  for (const clientOp of clientOperations) {
+    const headerName = getCustomRequestHeaderNameForOperation(
+      ignoreDiagnostics(getHttpOperation(program, clientOp))
+    );
+    if (headerName != undefined) {
+      return headerName;
+    }
+  }
+  return undefined;
+}
+
+function getCustomRequestHeaderNameForOperation(
+  route: HttpOperation
+): string | undefined {
+  const CUSTOM_REQUEST_HEADER_NAME = "client-request-id";
+  const params = route.parameters.parameters.filter(
+    (p) =>
+      p.type === "header" && p.name.toLowerCase() === CUSTOM_REQUEST_HEADER_NAME
+  );
+  if (params.length > 0) {
+    return CUSTOM_REQUEST_HEADER_NAME;
+  }
+
+  return undefined;
+}