@azure-tools/typespec-ts 0.29.0 → 0.30.0

package/src/transform/transformApiVersionInfo.ts

@@ -1,25 +1,25 @@
-import {
-  SdkClient,
-  isApiVersion,
-  listOperationGroups,
-  listOperationsInOperationGroup
-} from "@azure-tools/typespec-client-generator-core";
-import { ignoreDiagnostics } from "@typespec/compiler";
 import {
   ApiVersionInfo,
-  UrlInfo,
-  extractPathApiVersion,
+  ApiVersionPosition,
   extractDefinedPosition,
+  extractPathApiVersion,
   SchemaContext,
-  ApiVersionPosition
+  UrlInfo
 } from "@azure-tools/rlc-common";
+import {
+  isApiVersion,
+  listOperationGroups,
+  listOperationsInOperationGroup,
+  SdkClient
+} from "@azure-tools/typespec-client-generator-core";
+import { ignoreDiagnostics } from "@typespec/compiler";
 import { getHttpOperation } from "@typespec/http";
+import { SdkContext } from "../utils/interfaces.js";
 import {
   getDefaultApiVersionString,
   getSchemaForType,
   trimUsage
 } from "../utils/modelUtils.js";
-import { SdkContext } from "../utils/interfaces.js";
 
 export function transformApiVersionInfo(
   client: SdkClient,
@@ -29,7 +29,12 @@ export function transformApiVersionInfo(
   const queryVersionDetail = getOperationApiVersion(client, dpgContext);
   const pathVersionDetail = extractPathApiVersion(urlInfo);
   const isCrossedVersion =
-    pathVersionDetail?.isCrossedVersion || queryVersionDetail?.isCrossedVersion;
+    queryVersionDetail || pathVersionDetail
+      ? Boolean(
+          pathVersionDetail?.isCrossedVersion ||
+            queryVersionDetail?.isCrossedVersion
+        )
+      : undefined;
   const defaultValue =
     (pathVersionDetail || queryVersionDetail) && !isCrossedVersion
       ? getDefaultApiVersionString(dpgContext) ??
@@ -49,7 +54,8 @@ export function transformApiVersionInfo(
       pathVersionDetail
     ),
     isCrossedVersion,
-    defaultValue
+    defaultValue,
+    required: pathVersionDetail?.required ?? queryVersionDetail?.required
   };
 }
 
@@ -59,6 +65,7 @@ export function getOperationApiVersion(
 ): ApiVersionInfo | undefined {
   const apiVersionTypes = new Set<string>();
   const locations = new Set<ApiVersionPosition>();
+  const required = new Set<boolean>();
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   dpgContext.hasApiVersionInClient = true;
   let hasApiVersionInOperation = true;
@@ -81,6 +88,7 @@ export function getOperationApiVersion(
         needRef: false,
         relevantProperty: p.param
       });
+      required.add(!p.param.optional);
       if (p.type !== "header") {
         locations.add(p.type);
       }
@@ -121,14 +129,18 @@ export function getOperationApiVersion(
           needRef: false,
           relevantProperty: p.param
         });
+        required.add(!p.param.optional);
         if (p.type !== "header") {
           locations.add(p.type);
         }
-
         const typeString = JSON.stringify(trimUsage(type));
         apiVersionTypes.add(typeString);
       });
-      if (apiVersionTypes.size > 1 || !dpgContext.hasApiVersionInClient) {
+      if (
+        apiVersionTypes.size > 1 ||
+        !dpgContext.hasApiVersionInClient ||
+        required.size > 1
+      ) {
         break;
       }
       if (params.length === 1) {
@@ -147,7 +159,8 @@ export function getOperationApiVersion(
     definedPosition:
       locations.size > 1 ? "duplicate" : locations.values().next().value,
     isCrossedVersion: apiVersionTypes.size > 1,
-    defaultValue: undefined // We won't prompt the query versions into client one
+    defaultValue: undefined, // We won't prompt the query versions into client one
+    required: required.values().next().value
   };
   return detail;
 }

package/src/transform/transformHelperFunctionDetails.ts

@@ -1,20 +1,20 @@
+import { HelperFunctionDetails, PackageFlavor } from "@azure-tools/rlc-common";
 import {
-  SdkClient,
   listOperationGroups,
-  listOperationsInOperationGroup
+  listOperationsInOperationGroup,
+  SdkClient
 } from "@azure-tools/typespec-client-generator-core";
-import { HelperFunctionDetails, PackageFlavor } from "@azure-tools/rlc-common";
 import { ignoreDiagnostics, Model, Program, Type } from "@typespec/compiler";
 import { getHttpOperation, HttpOperation } from "@typespec/http";
+import { SdkContext } from "../utils/interfaces.js";
 import {
-  hasPagingOperations,
   extractPagedMetadataNested,
-  hasPollingOperations,
   getSpecialSerializeInfo,
-  parseNextLinkName,
-  parseItemName
+  hasPagingOperations,
+  hasPollingOperations,
+  parseItemName,
+  parseNextLinkName
 } from "../utils/operationUtil.js";
-import { SdkContext } from "../utils/interfaces.js";
 
 export function transformHelperFunctionDetails(
   client: SdkClient,

package/src/transform/transformParameters.ts

@@ -2,14 +2,14 @@
 // Licensed under the MIT License.
 
 import {
+  ApiVersionInfo,
   Imports,
   ObjectSchema,
   OperationParameter,
   ParameterBodyMetadata,
   ParameterMetadata,
   Schema,
-  SchemaContext,
-  ApiVersionInfo
+  SchemaContext
 } from "@azure-tools/rlc-common";
 import { ignoreDiagnostics, isVoidType, Type } from "@typespec/compiler";
 import {
@@ -19,32 +19,32 @@ import {
   HttpOperationParameters
 } from "@typespec/http";
 import {
+  getBodyType,
+  getFormattedPropertyDoc,
   getImportedModelName,
-  getTypeName,
   getSchemaForType,
-  getFormattedPropertyDoc,
-  getBodyType,
-  getSerializeTypeName
+  getSerializeTypeName,
+  getTypeName
 } from "../utils/modelUtils.js";
 
 import {
-  getOperationGroupName,
-  getOperationName,
-  getSpecialSerializeInfo
-} from "../utils/operationUtil.js";
-import {
-  SdkClient,
+  isApiVersion,
   listOperationGroups,
   listOperationsInOperationGroup,
-  isApiVersion
+  SdkClient
 } from "@azure-tools/typespec-client-generator-core";
 import { SdkContext } from "../utils/interfaces.js";
 import {
-  KnownMediaType,
   extractMediaTypes,
   hasMediaType,
-  isMediaTypeJsonMergePatch
+  isMediaTypeJsonMergePatch,
+  KnownMediaType
 } from "../utils/mediaTypes.js";
+import {
+  getOperationGroupName,
+  getOperationName,
+  getSpecialSerializeInfo
+} from "../utils/operationUtil.js";
 
 export function transformToParameterTypes(
   client: SdkClient,

package/src/transform/transformPaths.ts

@@ -2,25 +2,27 @@
 // Licensed under the MIT License.
 
 import {
-  getResponseTypeName,
   getParameterTypeName,
+  getResponseTypeName,
+  Imports,
+  OperationMethod,
   PathMetadata,
   Paths,
-  OperationMethod,
-  Imports
+  SchemaContext
 } from "@azure-tools/rlc-common";
+import {
+  isApiVersion,
+  listOperationGroups,
+  listOperationsInOperationGroup,
+  SdkClient
+} from "@azure-tools/typespec-client-generator-core";
 import { getDoc, ignoreDiagnostics } from "@typespec/compiler";
 import {
   getHttpOperation,
   HttpOperation,
   HttpOperationParameters
 } from "@typespec/http";
-import {
-  SdkClient,
-  listOperationGroups,
-  listOperationsInOperationGroup,
-  isApiVersion
-} from "@azure-tools/typespec-client-generator-core";
+import { SdkContext } from "../utils/interfaces.js";
 import {
   getImportedModelName,
   getSchemaForType,
@@ -28,16 +30,14 @@ import {
 } from "../utils/modelUtils.js";
 import {
   extractOperationLroDetail,
-  getOperationSuccessStatus,
   getOperationGroupName,
   getOperationName,
   getOperationResponseTypes,
   getOperationStatuscode,
+  getOperationSuccessStatus,
   isPagingOperation,
   sortedOperationResponses
 } from "../utils/operationUtil.js";
-import { SdkContext } from "../utils/interfaces.js";
-import { SchemaContext } from "@azure-tools/rlc-common";
 
 export function transformPaths(
   client: SdkClient,

package/src/transform/transformResponses.ts

@@ -2,40 +2,40 @@
 // Licensed under the MIT License.
 
 import {
-  SdkClient,
-  listOperationGroups,
-  listOperationsInOperationGroup
-} from "@azure-tools/typespec-client-generator-core";
-import {
-  ResponseHeaderSchema,
+  getLroLogicalResponseName,
+  Imports,
   OperationResponse,
+  ResponseHeaderSchema,
   ResponseMetadata,
   Schema,
-  SchemaContext,
-  getLroLogicalResponseName,
-  Imports
+  SchemaContext
 } from "@azure-tools/rlc-common";
+import {
+  listOperationGroups,
+  listOperationsInOperationGroup,
+  SdkClient
+} from "@azure-tools/typespec-client-generator-core";
 import { getDoc, ignoreDiagnostics, isVoidType } from "@typespec/compiler";
 import {
   getHttpOperation,
   HttpOperation,
   HttpOperationResponse
 } from "@typespec/http";
+import { SdkContext } from "../utils/interfaces.js";
 import {
+  getBinaryType,
   getImportedModelName,
-  getTypeName,
   getSchemaForType,
-  getBinaryType
+  getTypeName
 } from "../utils/modelUtils.js";
 import {
   getOperationGroupName,
-  getOperationStatuscode,
-  isBinaryPayload,
   getOperationLroOverload,
   getOperationName,
+  getOperationStatuscode,
+  isBinaryPayload,
   sortedOperationResponses
 } from "../utils/operationUtil.js";
-import { SdkContext } from "../utils/interfaces.js";
 
 export function transformToResponseTypes(
   client: SdkClient,
@@ -123,13 +123,16 @@ function transformHeaders(
     return;
   }
 
-  const rlcHeaders = [];
+  const rlcHeaders: Map<string, ResponseHeaderSchema> = new Map();
   // Current RLC client can't represent different headers per content type.
   // So we merge headers here, and report any duplicates.
   // It may be possible in principle to not error for identically declared
   // headers.
   for (const data of response.responses) {
-    const headers = data?.headers;
+    const headers = data?.headers ?? {};
+    if (data.body?.contentTypeProperty) {
+      headers["content-type"] = data.body?.contentTypeProperty;
+    }
     if (!headers || !Object.keys(headers).length) {
       continue;
     }
@@ -152,11 +155,11 @@ function transformHeaders(
         required: !value?.optional,
         description: getDoc(dpgContext.program, value!)
       };
-      rlcHeaders.push(header);
+      rlcHeaders.set(header.name, header);
     }
   }
 
-  return rlcHeaders.length ? rlcHeaders : undefined;
+  return rlcHeaders.size ? Array.from(rlcHeaders.values()) : undefined;
 }
 
 function transformBody(

package/src/transform/transformSchemas.ts

@@ -1,24 +1,25 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { SchemaContext } from "@azure-tools/rlc-common";
 import {
-  SdkClient,
   listOperationGroups,
-  listOperationsInOperationGroup
+  listOperationsInOperationGroup,
+  SdkClient
 } from "@azure-tools/typespec-client-generator-core";
-import { SchemaContext } from "@azure-tools/rlc-common";
 import { ignoreDiagnostics, Model, Type } from "@typespec/compiler";
 import { getHttpOperation, getServers, HttpOperation } from "@typespec/http";
+import { SdkContext } from "../utils/interfaces.js";
+import { extractMediaTypes, KnownMediaType } from "../utils/mediaTypes.js";
 import {
+  getBodyType,
+  getDefaultService,
   getSchemaForType,
   includeDerivedModel,
-  getBodyType,
-  trimUsage,
   isAzureCoreErrorType,
-  getDefaultService
+  trimUsage
 } from "../utils/modelUtils.js";
-import { SdkContext } from "../utils/interfaces.js";
-import { KnownMediaType, extractMediaTypes } from "../utils/mediaTypes.js";
+import { useContext } from "../contextManager.js";
 
 export function transformSchemas(client: SdkClient, dpgContext: SdkContext) {
   const program = dpgContext.program;
@@ -87,6 +88,12 @@ export function transformSchemas(client: SdkClient, dpgContext: SdkContext) {
             getGeneratedModels(value, SchemaContext.Output);
           }
         }
+        if (resps.body?.contentTypeProperty) {
+          getGeneratedModels(
+            resps.body.contentTypeProperty,
+            SchemaContext.Output
+          );
+        }
         const respModel = resps?.body?.type;
         if (!respModel) {
           continue;
@@ -112,6 +119,7 @@ export function transformSchemas(client: SdkClient, dpgContext: SdkContext) {
   }
   transformHostParameters();
   usageMap.forEach((context, tspModel) => {
+    const metatree = useContext("rlcMetaTree");
     const model = getSchemaForType(dpgContext, tspModel, {
       usage: context,
       isRequestBody: requestBodySet.has(tspModel),
@@ -121,6 +129,7 @@ export function transformSchemas(client: SdkClient, dpgContext: SdkContext) {
     if (model) {
       model.usage = context;
     }
+    metatree.set(tspModel, { rlcType: model });
     if (model.name === "") {
       return;
     }

package/src/transform/transformTelemetryInfo.ts

@@ -1,13 +1,13 @@
 import { TelemetryInfo } from "@azure-tools/rlc-common";
 import {
-  SdkClient,
-  SdkContext,
   listOperationGroups,
-  listOperationsInOperationGroup
+  listOperationsInOperationGroup,
+  SdkClient,
+  SdkContext
 } from "@azure-tools/typespec-client-generator-core";
 import { ignoreDiagnostics } from "@typespec/compiler";
-import { getCustomRequestHeaderNameForOperation } from "../utils/operationUtil.js";
 import { getHttpOperation } from "@typespec/http";
+import { getCustomRequestHeaderNameForOperation } from "../utils/operationUtil.js";
 
 export function transformTelemetryInfo(
   client: SdkClient,

package/src/transform/transfromRLCOptions.ts

@@ -1,4 +1,5 @@
 import {
+  pascalCase,
   NameType,
   normalizeName,
   PackageDetails,
@@ -6,6 +7,10 @@ import {
   RLCOptions,
   ServiceInfo
 } from "@azure-tools/rlc-common";
+import {
+  listOperationGroups,
+  listOperationsInOperationGroup
+} from "@azure-tools/typespec-client-generator-core";
 import {
   getDoc,
   ignoreDiagnostics,
@@ -14,15 +19,11 @@ import {
 } from "@typespec/compiler";
 import { getAuthentication, getHttpOperation } from "@typespec/http";
 import { EmitterOptions, 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";
+import { getDefaultService } from "../utils/modelUtils.js";
 import { detectModelConflicts } from "../utils/namespaceUtils.js";
+import { getOperationName } from "../utils/operationUtil.js";
 
 export function transformRLCOptions(
   emitterOptions: EmitterOptions,
@@ -106,7 +107,13 @@ function processAuth(program: Program) {
         case "http":
           securityInfo.addCredentials = true;
           securityInfo.customHttpAuthHeaderName = "Authorization";
-          securityInfo.customHttpAuthSharedKeyPrefix = auth.scheme;
+          // If it is basic or bearer auth we should generate it as Basic or Bearer
+          securityInfo.customHttpAuthSharedKeyPrefix = [
+            "basic",
+            "bearer"
+          ].includes(auth.scheme.toLowerCase())
+            ? pascalCase(auth.scheme)
+            : auth.scheme;
           break;
         case "apiKey":
           if (auth.in === "cookie") {

package/src/utils/clientUtils.ts

@@ -1,8 +1,8 @@
 import { SdkClient } from "@azure-tools/typespec-client-generator-core";
 import {
-  Namespace,
   getNamespaceFullName,
-  listServices
+  listServices,
+  Namespace
 } from "@typespec/compiler";
 import { SdkContext } from "./interfaces.js";
 

package/src/utils/emitUtil.ts

@@ -1,6 +1,9 @@
-import { ContentBuilder } from "@azure-tools/rlc-common";
-import { buildSchemaTypes } from "@azure-tools/rlc-common";
-import { File, RLCModel } from "@azure-tools/rlc-common";
+import {
+  buildSchemaTypes,
+  ContentBuilder,
+  File,
+  RLCModel
+} from "@azure-tools/rlc-common";
 import { CompilerHost, Program } from "@typespec/compiler";
 import { dirname, join } from "path";
 import { format } from "prettier";

package/src/utils/importHelper.ts

@@ -0,0 +1,64 @@
+import { dirname, relative, resolve } from "path";
+import { useContext } from "../contextManager.js";
+import { SourceFile } from "ts-morph";
+
+/**
+ * Adds a named import to a TypeScript source file if it does not already exist.
+ * Utilizes a global symbol map context to resolve module paths and ensure the import is correctly referenced.
+ *
+ * @param {string} symbol The name of the export to import.
+ * @param {SourceFile} currentFile The ts-morph SourceFile object where the import will be added.
+ */
+export function addImportBySymbol(symbol: string, currentFile: SourceFile) {
+  // Retrieve the global map of symbols to their source files.
+  const symbolMap = useContext("symbolMap");
+
+  // Attempt to resolve the file path for the given symbol.
+  const modulePath = symbolMap.get(symbol)?.getFilePath();
+  if (!modulePath) {
+    return;
+  }
+
+  // Resolve absolute path and compute a relative path from the current file to the module.
+  const moduleAbsolutePath = resolve(modulePath);
+  const relativeImportPath = getRelativeImportPath(
+    currentFile.getFilePath(),
+    moduleAbsolutePath
+  )
+    .replace(/\\/g, "/")
+    .replace(/\.ts$/, ".js");
+
+  // Check if the import declaration already exists and if it includes the symbol.
+  const existing = currentFile.getImportDeclaration(
+    (i) => i.getModuleSpecifierValue() === relativeImportPath
+  );
+
+  if (existing) {
+    const sameImport = existing
+      .getNamedImports()
+      .some((i) => i.getName() === symbol);
+
+    if (!sameImport) {
+      existing.addNamedImport(symbol);
+    }
+  } else {
+    currentFile.addImportDeclaration({
+      moduleSpecifier: relativeImportPath,
+      namedImports: [symbol]
+    });
+  }
+}
+
+/**
+ * Computes a relative import path suitable for TypeScript imports given two file paths.
+ * Ensures the returned path starts with './' if necessary to be recognized as a relative module.
+ *
+ * @param {string} from The file path to import from.
+ * @param {string} to The file path to import to.
+ * @returns {string} The relative path adjusted for import syntax.
+ */
+function getRelativeImportPath(from: string, to: string) {
+  const relativePath = relative(dirname(from), to);
+  // Adjust the path format to TypeScript module syntax
+  return relativePath.startsWith(".") ? relativePath : "./" + relativePath;
+}