@azure-tools/typespec-ts 0.15.0 → 0.16.0

package/src/modular/modularCodeModel.ts

@@ -1,11 +1,17 @@
 import { OperationResponse, RLCOptions } from "@azure-tools/rlc-common";
+import { Project } from "ts-morph";
 
+export interface ModularOptions {
+  sourceRoot: string;
+}
 export interface ModularCodeModel {
   options: RLCOptions;
+  modularOptions: ModularOptions;
   namespace?: string;
   subnamespaceToClients?: any;
   clients: Client[];
   types: Type[];
+  project: Project;
 }
 
 export interface Header {
@@ -21,6 +27,7 @@ export interface Property {
   optional?: boolean;
   description: string;
   readonly?: boolean;
+  format?: string;
 }
 
 export interface BodyParameter {
@@ -81,6 +88,7 @@ export interface Type {
   isFixed?: boolean;
   valueType?: Type;
   elementType?: Type;
+  parents?: Type[];
   xmlMetadata?: XmlMetadata;
   format?: string;
   properties?: Property[];
@@ -96,6 +104,7 @@ export interface Client {
   url: string;
   apiVersions: any[];
   rlcClientName: string;
+  subfolder?: string;
 }
 
 export type ParameterLocation =
@@ -124,6 +133,7 @@ export interface Parameter {
   inDocstring?: boolean;
   inOverriden?: boolean;
   isApiVersion?: boolean;
+  format?: string;
 }
 
 export interface Response {
@@ -136,6 +146,7 @@ export interface Response {
 
 export interface Operation {
   name: string;
+  oriName?: string;
   description: string;
   summary: string;
   url: string;

package/src/transform/transformHelperFunctionDetails.ts

@@ -10,9 +10,9 @@ 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(
@@ -199,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;
@@ -222,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 {
@@ -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 ||
@@ -279,7 +283,7 @@ function transformNormalBody(
   if (hasBinaryContent) {
     descriptions.push("Value may contain any sequence of octets");
   }
-  const type = extractNameFromCadlType(
+  const type = extractNameFromTypeSpecType(
     dpgContext,
     bodyType,
     importedModels,
@@ -315,7 +319,11 @@ function transformMultiFormBody(
   const isModelBody = bodyType.kind === "Model";
 
   if (!isModelBody) {
-    const type = extractNameFromCadlType(dpgContext, bodyType, importedModels);
+    const type = extractNameFromTypeSpecType(
+      dpgContext,
+      bodyType,
+      importedModels
+    );
     const description = extractDescriptionsFromBody(
       dpgContext,
       bodyType,
@@ -357,7 +365,7 @@ function transformMultiFormBody(
         SchemaContext.Exception
       ])}>`;
     } else {
-      type = extractNameFromCadlType(
+      type = extractNameFromTypeSpecType(
         dpgContext,
         paramType.type,
         importedModels
@@ -388,13 +396,13 @@ function getBodyDetail(
   return { hasBinaryContent, hasFormContent };
 }
 
-function extractNameFromCadlType(
+function extractNameFromTypeSpecType(
   dpgContext: SdkContext,
-  cadlType: Type,
+  type: Type,
   importedModels: Set<string>,
   headers?: ParameterMetadata[]
 ) {
-  const bodySchema = getSchemaForType(dpgContext, cadlType, [
+  const bodySchema = getSchemaForType(dpgContext, type, [
     SchemaContext.Input,
     SchemaContext.Exception
   ]) as Schema;
@@ -470,53 +478,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/transformResponses.ts

@@ -182,12 +182,10 @@ function transformBody(
     const bodySchema = getSchemaForType(dpgContext, body!.type, [
       SchemaContext.Output
     ]) as Schema;
-    if (bodySchema.fromCore) {
-      fromCore = true;
-    }
+    fromCore = bodySchema.fromCore ?? false;
     const bodyType = getTypeName(bodySchema);
     const importedNames = getImportedModelName(bodySchema);
-    if (importedNames) {
+    if (importedNames && !fromCore) {
       importedNames
         .filter((name) => {
           return name !== "any";

package/src/transform/transformSchemas.ts

@@ -13,7 +13,8 @@ import {
   getSchemaForType,
   includeDerivedModel,
   getBodyType,
-  trimUsage
+  trimUsage,
+  isAzureCoreErrorType
 } from "../utils/modelUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
 
@@ -61,12 +62,7 @@ export function transformSchemas(
       getGeneratedModels(bodyModel, SchemaContext.Input);
     }
     for (const resp of route.responses) {
-      if (
-        resp.type.kind === "Model" &&
-        resp.type.name === "ErrorResponse" &&
-        resp.type.namespace?.name === "Foundations" &&
-        resp.type.namespace.namespace?.name === "Core"
-      ) {
+      if (isAzureCoreErrorType(resp.type)) {
         continue;
       }
       for (const resps of resp.responses) {
@@ -78,8 +74,8 @@ export function transformSchemas(
       }
     }
   }
-  program.stateMap(modelKey).forEach((context, cadlModel) => {
-    const model = getSchemaForType(dpgContext, cadlModel, context);
+  program.stateMap(modelKey).forEach((context, tspModel) => {
+    const model = getSchemaForType(dpgContext, tspModel, context);
     if (model) {
       model.usage = context;
     }

package/src/transform/transformTelemetryInfo.ts

@@ -6,7 +6,8 @@ import {
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
 import { ignoreDiagnostics } from "@typespec/compiler";
-import { getHttpOperation, HttpOperation } from "@typespec/http";
+import { getCustomRequestHeaderNameForOperation } from "../utils/operationUtil.js";
+import { getHttpOperation } from "@typespec/http";
 
 export function transformTelemetryInfo(
   dpgContext: SdkContext,
@@ -39,7 +40,7 @@ function getCustomRequestHeaderNameForClient(
       const headerName = getCustomRequestHeaderNameForOperation(
         ignoreDiagnostics(getHttpOperation(program, op))
       );
-      if (headerName != undefined) {
+      if (headerName !== undefined) {
         return headerName;
       }
     }
@@ -49,24 +50,9 @@ function getCustomRequestHeaderNameForClient(
     const headerName = getCustomRequestHeaderNameForOperation(
       ignoreDiagnostics(getHttpOperation(program, clientOp))
     );
-    if (headerName != undefined) {
+    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;
-}

package/src/transform/transfromRLCOptions.ts

@@ -5,12 +5,22 @@ import {
   RLCOptions,
   ServiceInfo
 } from "@azure-tools/rlc-common";
-import { getDoc, NoTarget, Program } from "@typespec/compiler";
-import { getAuthentication } from "@typespec/http";
+import {
+  getDoc,
+  ignoreDiagnostics,
+  NoTarget,
+  Program
+} from "@typespec/compiler";
+import { getAuthentication, getHttpOperation } from "@typespec/http";
 import { reportDiagnostic } from "../lib.js";
 import { getDefaultService } from "../utils/modelUtils.js";
 import { getRLCClients } from "../utils/clientUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
+import {
+  listOperationGroups,
+  listOperationsInOperationGroup
+} from "@azure-tools/typespec-client-generator-core";
+import { getOperationName } from "../utils/operationUtil.js";
 
 export function transformRLCOptions(
   emitterOptions: RLCOptions,
@@ -18,7 +28,7 @@ export function transformRLCOptions(
 ): RLCOptions {
   // Extract the options from emitter option
   const options = extractRLCOptions(
-    dpgContext.program,
+    dpgContext,
     emitterOptions,
     dpgContext.generationPathDetail?.rootDir ?? ""
   );
@@ -28,10 +38,11 @@ export function transformRLCOptions(
 }
 
 function extractRLCOptions(
-  program: Program,
+  dpgContext: SdkContext,
   emitterOptions: RLCOptions,
   generationRootDir: string
 ): RLCOptions {
+  const program = dpgContext.program;
   const includeShortcuts = getIncludeShortcuts(emitterOptions);
   const packageDetails = getPackageDetails(program, emitterOptions);
   const serviceInfo = getServiceInfo(program);
@@ -41,7 +52,10 @@ function extractRLCOptions(
   const generateTest: undefined | boolean = getGenerateTest(emitterOptions);
   const credentialInfo = getCredentialInfo(program, emitterOptions);
   const azureOutputDirectory = getAzureOutputDirectory(generationRootDir);
-  const enableOperationGroup = getEnableOperationGroup(emitterOptions);
+  const enableOperationGroup = getEnableOperationGroup(
+    dpgContext,
+    emitterOptions
+  );
   return {
     ...emitterOptions,
     ...credentialInfo,
@@ -52,7 +66,7 @@ function extractRLCOptions(
     azureSdkForJs,
     serviceInfo,
     azureOutputDirectory,
-    sourceFrom: "Cadl",
+    sourceFrom: "TypeSpec",
     enableOperationGroup
   };
 }
@@ -112,10 +126,54 @@ function processAuth(program: Program) {
   return securityInfo;
 }
 
-function getEnableOperationGroup(emitterOptions: RLCOptions) {
-  if (emitterOptions.enableOperationGroup === true) {
-    return true;
+function getEnableOperationGroup(
+  dpgContext: SdkContext,
+  emitterOptions: RLCOptions
+) {
+  if (
+    emitterOptions.enableOperationGroup === true ||
+    emitterOptions.enableOperationGroup === false
+  ) {
+    return emitterOptions.enableOperationGroup;
   }
+  // Detect if existing name conflicts if customers didn't set the option explicitly
+  return detectIfNameConflicts(dpgContext);
+}
+
+function detectIfNameConflicts(dpgContext: SdkContext) {
+  const clients = getRLCClients(dpgContext);
+  const program = dpgContext.program;
+  const nameSet = new Set<string>();
+  for (const client of clients) {
+    const operationGroups = listOperationGroups(dpgContext, client);
+    for (const operationGroup of operationGroups) {
+      const operations = listOperationsInOperationGroup(
+        dpgContext,
+        operationGroup
+      );
+      for (const op of operations) {
+        const route = ignoreDiagnostics(getHttpOperation(program, op));
+        const name = getOperationName(program, route.operation);
+        if (nameSet.has(name)) {
+          return true;
+        } else {
+          nameSet.add(name);
+        }
+      }
+    }
+    const clientOperations = listOperationsInOperationGroup(dpgContext, client);
+    for (const clientOp of clientOperations) {
+      const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+      const name = getOperationName(program, route.operation);
+      if (nameSet.has(name)) {
+        return true;
+      } else {
+        nameSet.add(name);
+      }
+    }
+  }
+
+  // No conflicts if we didn't detect any
   return false;
 }