@azure-tools/typespec-ts 0.18.0 → 0.19.0

package/src/modular/helpers/operationHelpers.ts

@@ -14,13 +14,14 @@ import {
 } from "../modularCodeModel.js";
 import { buildType } from "./typeHelpers.js";
 import {
+  Imports as RuntimeImports,
   NameType,
   OperationResponse,
   getResponseBaseName,
   getResponseTypeName,
   normalizeName
 } from "@azure-tools/rlc-common";
-import { getOperationName } from "./namingHelpers.js";
+import { getClassicalLayerPrefix, getOperationName } from "./namingHelpers.js";
 import {
   getFixmeForMultilineDocs,
   getDocsFromDescription
@@ -32,6 +33,7 @@ import {
 import { SdkContext } from "@azure-tools/typespec-client-generator-core";
 import { Program, NoTarget } from "@typespec/compiler";
 import { reportDiagnostic } from "../../lib.js";
+import { getImportSpecifier } from "@azure-tools/rlc-common";
 
 function getRLCResponseType(rlcResponse?: OperationResponse) {
   if (!rlcResponse?.responses) {
@@ -54,17 +56,21 @@ export function getSendPrivateFunction(
   dpgContext: SdkContext,
   operation: Operation,
   clientType: string,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ): OptionalKind<FunctionDeclarationStructure> {
   const parameters = getOperationSignatureParameters(operation, clientType);
   const { name } = getOperationName(operation);
+  const returnType = `StreamableMethod<${getRLCResponseType(
+    operation.rlcResponse
+  )}>`;
 
   const functionStatement: OptionalKind<FunctionDeclarationStructure> = {
     isAsync: false,
     isExported: true,
     name: `_${name}Send`,
     parameters,
-    returnType: `StreamableMethod<${getRLCResponseType(operation.rlcResponse)}>`
+    returnType
   };
 
   const operationPath = operation.url;
@@ -77,8 +83,9 @@ export function getSendPrivateFunction(
     )}).${operationMethod}({...operationOptionsToRequestParameters(options), ${getRequestParameters(
       dpgContext,
       operation,
-      importSet
-    )}});`
+      importSet,
+      runtimeImports
+    )}}) ${operation.isOverload ? `as ${returnType}` : ``} ;`
   );
 
   return {
@@ -91,7 +98,8 @@ export function getDeserializePrivateFunction(
   operation: Operation,
   needSubClient: boolean,
   needUnexpectedHelper: boolean,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ): OptionalKind<FunctionDeclarationStructure> {
   const { name } = getOperationName(operation);
 
@@ -157,7 +165,8 @@ export function getDeserializePrivateFunction(
       getResponseMapping(
         getAllProperties(response.type) ?? [],
         "result.body",
-        importSet
+        importSet,
+        runtimeImports
       ).join(","),
       `}`
     );
@@ -169,6 +178,7 @@ export function getDeserializePrivateFunction(
         response.type,
         "result.body",
         importSet,
+        runtimeImports,
         response.type.nullable !== undefined ? !response.type.nullable : false,
         response.type.format
       )}`
@@ -184,7 +194,7 @@ function getOperationSignatureParameters(
   operation: Operation,
   clientType: string
 ): OptionalKind<ParameterDeclarationStructure>[] {
-  const optionsType = getOperationOptionsName(operation);
+  const optionsType = getOperationOptionsName(operation, true);
   const parameters: Map<
     string,
     OptionalKind<ParameterDeclarationStructure>
@@ -270,12 +280,14 @@ export function getOperationFunction(
     statements
   };
 }
-
 export function getOperationOptionsName(
   operation: Operation,
   includeGroupName = false
 ) {
-  const prefix = includeGroupName ? toPascalCase(operation.groupName) : "";
+  const prefix =
+    includeGroupName && operation.name.indexOf("_") === -1
+      ? getClassicalLayerPrefix(operation, NameType.Interface)
+      : "";
   const optionName = `${prefix}${toPascalCase(operation.name)}Options`;
   if (operation.bodyParameter?.type.name === optionName) {
     return optionName.replace(/Options$/, "RequestOptions");
@@ -291,7 +303,8 @@ export function getOperationOptionsName(
 function getRequestParameters(
   dpgContext: SdkContext,
   operation: Operation,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ): string {
   if (!operation.parameters) {
     return "";
@@ -318,7 +331,7 @@ function getRequestParameters(
       param.location === "body"
     ) {
       parametersImplementation[param.location].push({
-        paramMap: getParameterMap(param, importSet),
+        paramMap: getParameterMap(param, importSet, runtimeImports),
         param
       });
     }
@@ -351,7 +364,8 @@ function getRequestParameters(
   } else if (operation.bodyParameter !== undefined) {
     paramStr = `${paramStr}${buildBodyParameter(
       operation.bodyParameter,
-      importSet
+      importSet,
+      runtimeImports
     )}`;
   }
   return paramStr;
@@ -384,7 +398,8 @@ function buildHeaderParameter(
 
 function buildBodyParameter(
   bodyParameter: BodyParameter | undefined,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ) {
   if (!bodyParameter) {
     return "";
@@ -394,7 +409,8 @@ function buildBodyParameter(
     const bodyParts: string[] = getRequestModelMapping(
       bodyParameter.type,
       bodyParameter.clientName,
-      importSet
+      importSet,
+      runtimeImports
     );
 
     if (bodyParameter && bodyParts.length > 0) {
@@ -407,7 +423,8 @@ function buildBodyParameter(
       const bodyParts = getRequestModelMapping(
         bodyParameter.type.elementType,
         "p",
-        importSet
+        importSet,
+        runtimeImports
       );
       return `\nbody: (${bodyParameter.clientName} ?? []).map((p) => { return {
         ${bodyParts.join(", ")}
@@ -420,12 +437,10 @@ function buildBodyParameter(
     bodyParameter.type.type === "byte-array" &&
     !bodyParameter.isBinaryPayload
   ) {
-    const coreUtilSet = importSet.get("@azure/core-util");
+    const specifier = getImportSpecifier("coreUtil", runtimeImports);
+    const coreUtilSet = importSet.get(specifier);
     if (!coreUtilSet) {
-      importSet.set(
-        "@azure/core-util",
-        new Set<string>().add("uint8ArrayToString")
-      );
+      importSet.set(specifier, new Set<string>().add("uint8ArrayToString"));
     } else {
       coreUtilSet.add("uint8ArrayToString");
     }
@@ -460,23 +475,24 @@ function getEncodingFormat(type: { format?: string }) {
  */
 function getParameterMap(
   param: Parameter | Property,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ): string {
   if (isConstant(param)) {
     return getConstantValue(param);
   }
 
   if (hasCollectionFormatInfo((param as any).location, (param as any).format)) {
-    return getCollectionFormat(param as Parameter, importSet);
+    return getCollectionFormat(param as Parameter, importSet, runtimeImports);
   }
 
   // if the parameter or property is optional, we don't need to handle the default value
   if (isOptional(param)) {
-    return getOptional(param, importSet);
+    return getOptional(param, importSet, runtimeImports);
   }
 
   if (isRequired(param)) {
-    return getRequired(param, importSet);
+    return getRequired(param, importSet, runtimeImports);
   }
 
   throw new Error(`Parameter ${param.clientName} is not supported`);
@@ -484,7 +500,8 @@ function getParameterMap(
 
 function getCollectionFormat(
   param: Parameter,
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ) {
   const collectionInfo = getCollectionFormatHelper(
     param.location,
@@ -500,6 +517,7 @@ function getCollectionFormat(
       param.type,
       param.clientName,
       importSet,
+      runtimeImports,
       true,
       param.format
     )}${additionalParam})`;
@@ -510,6 +528,7 @@ function getCollectionFormat(
     param.type,
     "options?." + param.clientName,
     importSet,
+    runtimeImports,
     false,
     param.format
   )}${additionalParam}): undefined`;
@@ -547,18 +566,24 @@ function isRequired(param: Parameter | Property): param is RequiredType {
   return !param.optional;
 }
 
-function getRequired(param: RequiredType, importSet: Map<string, Set<string>>) {
+function getRequired(
+  param: RequiredType,
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
+) {
   if (param.type.type === "model") {
     return `"${param.restApiName}": {${getRequestModelMapping(
       param.type,
       param.clientName,
-      importSet
+      importSet,
+      runtimeImports
     ).join(",")}}`;
   }
   return `"${param.restApiName}": ${serializeRequestValue(
     param.type,
     param.clientName,
     importSet,
+    runtimeImports,
     true,
     param.format === undefined &&
       (param as Parameter).location === "header" &&
@@ -599,18 +624,24 @@ function isOptional(param: Parameter | Property): param is OptionalType {
   return Boolean(param.optional);
 }
 
-function getOptional(param: OptionalType, importSet: Map<string, Set<string>>) {
+function getOptional(
+  param: OptionalType,
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
+) {
   if (param.type.type === "model") {
     return `"${param.restApiName}": {${getRequestModelMapping(
       param.type,
       "options?." + param.clientName + "?",
-      importSet
+      importSet,
+      runtimeImports
     ).join(", ")}}`;
   }
   return `"${param.restApiName}": ${serializeRequestValue(
     param.type,
     `options?.${param.clientName}`,
     importSet,
+    runtimeImports,
     false,
     param.format === undefined &&
       (param as Parameter).location === "header" &&
@@ -679,7 +710,8 @@ function getNullableCheck(name: string, type: Type) {
 function getRequestModelMapping(
   modelPropertyType: Type,
   propertyPath: string = "body",
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ) {
   if (getAllProperties(modelPropertyType).length <= 0) {
     return [];
@@ -722,7 +754,8 @@ function getRequestModelMapping(
           `${propertyPath}.${property.clientName}${
             property.optional ? "?" : ""
           }`,
-          importSet
+          importSet,
+          runtimeImports
         )}}`;
       }
 
@@ -749,6 +782,7 @@ function getRequestModelMapping(
           property.type,
           clientValue,
           importSet,
+          runtimeImports,
           !property.optional,
           property.format
         )}`
@@ -766,7 +800,8 @@ function getRequestModelMapping(
 export function getResponseMapping(
   properties: Property[],
   propertyPath: string = "result.body",
-  importSet: Map<string, Set<string>>
+  importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports
 ) {
   const props: string[] = [];
   for (const property of properties) {
@@ -803,7 +838,8 @@ export function getResponseMapping(
           `${propertyPath}.${property.restApiName}${
             property.optional ? "?" : ""
           }`,
-          importSet
+          importSet,
+          runtimeImports
         )}}`;
       }
 
@@ -832,6 +868,7 @@ export function getResponseMapping(
             property.type,
             restValue,
             importSet,
+            runtimeImports,
             property.optional !== undefined ? !property.optional : false,
             property.format
           )}`
@@ -852,10 +889,12 @@ function deserializeResponseValue(
   type: Type,
   restValue: string,
   importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports,
   required: boolean,
   format?: string
 ): string {
-  const coreUtilSet = importSet.get("@azure/core-util");
+  const coreSpecifier = getImportSpecifier("coreUtil", runtimeImports);
+  const coreUtilSet = importSet.get(coreSpecifier);
   switch (type.type) {
     case "datetime":
       return required
@@ -865,29 +904,36 @@ function deserializeResponseValue(
         : `${restValue} !== undefined? new Date(${restValue}): undefined`;
     case "combined":
       return `${restValue} as any`;
-    case "list":
+    case "list": {
+      const prefix =
+        required && !type.nullable
+          ? `${restValue}`
+          : `!${restValue} ? ${restValue} : ${restValue}`;
       if (type.elementType?.type === "model") {
-        return `(${restValue} ?? []).map(p => ({${getResponseMapping(
+        return `${prefix}.map(p => ({${getResponseMapping(
           getAllProperties(type.elementType) ?? [],
           "p",
-          importSet
+          importSet,
+          runtimeImports
         )}}))`;
       } else if (needsDeserialize(type.elementType)) {
-        return `(${restValue} ?? []).map(p => ${deserializeResponseValue(
+        return `${prefix}.map(p => ${deserializeResponseValue(
           type.elementType!,
           "p",
           importSet,
+          runtimeImports,
           required,
           type.elementType?.format
         )})`;
       } else {
         return restValue;
       }
+    }
     case "byte-array":
       if (format !== "binary") {
         if (!coreUtilSet) {
           importSet.set(
-            "@azure/core-util",
+            coreSpecifier,
             new Set<string>().add("stringToUint8Array")
           );
         } else {
@@ -912,10 +958,12 @@ function serializeRequestValue(
   type: Type,
   clientValue: string,
   importSet: Map<string, Set<string>>,
+  runtimeImports: RuntimeImports,
   required: boolean,
   format?: string
 ): string {
-  const coreUtilSet = importSet.get("@azure/core-util");
+  const utilSpecifier = getImportSpecifier("coreUtil", runtimeImports);
+  const coreUtilSet = importSet.get(utilSpecifier);
   switch (type.type) {
     case "datetime":
       switch (type.format ?? format) {
@@ -932,29 +980,36 @@ function serializeRequestValue(
         default:
           return `${clientValue}${required ? "" : "?"}.toISOString()`;
       }
-    case "list":
+    case "list": {
+      const prefix =
+        required && !type.nullable
+          ? `${clientValue}`
+          : `!${clientValue} ? ${clientValue} : ${clientValue}`;
       if (type.elementType?.type === "model") {
-        return `(${clientValue} ?? []).map(p => ({${getRequestModelMapping(
+        return `${prefix}.map(p => ({${getRequestModelMapping(
           type.elementType,
           "p",
-          importSet
+          importSet,
+          runtimeImports
         )}}))`;
       } else if (needsDeserialize(type.elementType)) {
-        return `(${clientValue} ?? []).map(p => ${serializeRequestValue(
+        return `${prefix}.map(p => ${serializeRequestValue(
           type.elementType!,
           "p",
           importSet,
+          runtimeImports,
           required,
           type.elementType?.format
         )})`;
       } else {
         return clientValue;
       }
+    }
     case "byte-array":
       if (format !== "binary") {
         if (!coreUtilSet) {
           importSet.set(
-            "@azure/core-util",
+            utilSpecifier,
             new Set<string>().add("uint8ArrayToString")
           );
         } else {

package/src/modular/modularCodeModel.ts

@@ -1,3 +1,4 @@
+import { Imports } from "@azure-tools/rlc-common";
 import { OperationResponse, RLCOptions } from "@azure-tools/rlc-common";
 import { Project } from "ts-morph";
 
@@ -12,6 +13,7 @@ export interface ModularCodeModel {
   clients: Client[];
   types: Type[];
   project: Project;
+  runtimeImports: Imports;
 }
 
 export interface Header {
@@ -47,6 +49,7 @@ export interface OperationGroup {
   className: string;
   propertyName: string;
   operations: Operation[];
+  namespaceHierarchies: string[];
 }
 export interface Policy {
   type: string;
@@ -168,4 +171,5 @@ export interface Operation {
   continuationTokenName?: string;
   addedOn?: string;
   rlcResponse?: OperationResponse;
+  namespaceHierarchies: string[];
 }

package/src/transform/transform.ts

@@ -3,7 +3,7 @@
 
 import { SdkClient } from "@azure-tools/typespec-client-generator-core";
 import {
-  ImportKind,
+  buildRuntimeImports,
   NameType,
   normalizeName,
   OperationParameter,
@@ -14,7 +14,9 @@ import {
   RLCOptions,
   Schema,
   SchemaContext,
-  UrlInfo
+  UrlInfo,
+  initInternalImports,
+  transformSampleGroups
 } from "@azure-tools/rlc-common";
 import { getDoc } from "@typespec/compiler";
 import { getServers } from "@typespec/http";
@@ -35,7 +37,6 @@ import { transformApiVersionInfo } from "./transformApiVersionInfo.js";
 import { getClientLroOverload } from "../utils/operationUtil.js";
 import { transformTelemetryInfo } from "./transformTelemetryInfo.js";
 import { SdkContext } from "../utils/interfaces.js";
-import { transformSampleGroups } from "@azure-tools/rlc-common";
 
 export async function transformRLCModel(
   client: SdkClient,
@@ -58,7 +59,7 @@ export async function transformRLCModel(
           "",
     NameType.Class
   );
-  const importSet = new Map<ImportKind, Set<string>>();
+  const importSet = initInternalImports();
   const paths: Paths = transformPaths(program, client, dpgContext);
   const schemas: Schema[] = transformSchemas(program, client, dpgContext);
   const responses: OperationResponse[] = transformToResponseTypes(
@@ -84,12 +85,15 @@ export async function transformRLCModel(
     options,
     schemas,
     responses,
-    importSet,
     apiVersionInfo,
     parameters,
     helperDetails,
     urlInfo,
-    telemetryOptions
+    telemetryOptions,
+    importInfo: {
+      internalImports: importSet,
+      runtimeImports: buildRuntimeImports(options.branded)
+    }
   };
   model.sampleGroups = transformSampleGroups(
     model,

package/src/transform/transformParameters.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import {
-  ImportKind,
+  Imports,
   ObjectSchema,
   OperationParameter,
   ParameterBodyMetadata,
@@ -42,7 +42,7 @@ import {
 import { SdkContext } from "../utils/interfaces.js";
 
 export function transformToParameterTypes(
-  importDetails: Map<ImportKind, Set<string>>,
+  importDetails: Imports,
   client: SdkClient,
   dpgContext: SdkContext
 ): OperationParameter[] {
@@ -74,7 +74,7 @@ export function transformToParameterTypes(
     transformToParameterTypesForRoute(program, route);
   }
   if (outputImportedSet.size > 0) {
-    importDetails.set(ImportKind.ParameterInput, outputImportedSet);
+    importDetails.parameter.importsSet = outputImportedSet;
   }
   function transformToParameterTypesForRoute(
     program: Program,

package/src/transform/transformResponses.ts

@@ -8,12 +8,12 @@ import {
 } from "@azure-tools/typespec-client-generator-core";
 import {
   ResponseHeaderSchema,
-  ImportKind,
   OperationResponse,
   ResponseMetadata,
   Schema,
   SchemaContext,
-  getLroLogicalResponseName
+  getLroLogicalResponseName,
+  Imports
 } from "@azure-tools/rlc-common";
 import { getDoc, ignoreDiagnostics } from "@typespec/compiler";
 import {
@@ -38,7 +38,7 @@ import {
 import { SdkContext } from "../utils/interfaces.js";
 
 export function transformToResponseTypes(
-  importDetails: Map<ImportKind, Set<string>>,
+  importDetails: Imports,
   client: SdkClient,
   dpgContext: SdkContext
 ): OperationResponse[] {
@@ -70,7 +70,7 @@ export function transformToResponseTypes(
     transformToResponseTypesForRoute(route);
   }
   if (inputImportedSet.size > 0) {
-    importDetails.set(ImportKind.ResponseOutput, inputImportedSet);
+    importDetails.response.importsSet = inputImportedSet;
   }
   function transformToResponseTypesForRoute(route: HttpOperation) {
     const rlcOperationUnit: OperationResponse = {

package/src/transform/transfromRLCOptions.ts

@@ -21,6 +21,7 @@ import {
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
 import { getOperationName } from "../utils/operationUtil.js";
+import { detectModelConflicts } from "../utils/namespaceUtils.js";
 
 export function transformRLCOptions(
   emitterOptions: RLCOptions,
@@ -56,9 +57,15 @@ function extractRLCOptions(
     dpgContext,
     emitterOptions
   );
+  const enableModelNamespace = getEnableModelNamespace(
+    dpgContext,
+    emitterOptions
+  );
+  const hierarchyClient = getHierarchyClient(emitterOptions);
   return {
     ...emitterOptions,
     ...credentialInfo,
+    branded: getBranded(emitterOptions),
     includeShortcuts,
     packageDetails,
     generateMetadata,
@@ -67,7 +74,9 @@ function extractRLCOptions(
     serviceInfo,
     azureOutputDirectory,
     sourceFrom: "TypeSpec",
-    enableOperationGroup
+    enableOperationGroup,
+    enableModelNamespace,
+    hierarchyClient
   };
 }
 
@@ -136,15 +145,41 @@ function getEnableOperationGroup(
   ) {
     return emitterOptions.enableOperationGroup;
   }
-  // Detect if existing name conflicts if customers didn't set the option explicitly
+  // Only detect if existing name conflicts if customers don't set hierarchyClient to true
   return detectIfNameConflicts(dpgContext);
 }
 
+function getEnableModelNamespace(
+  dpgContext: SdkContext,
+  emitterOptions: RLCOptions
+) {
+  if (
+    emitterOptions.enableModelNamespace === true ||
+    emitterOptions.enableModelNamespace === false
+  ) {
+    return emitterOptions.enableModelNamespace;
+  }
+  // Detect if existing name conflicts if customers didn't set the option explicitly
+  return detectModelConflicts(dpgContext);
+}
+
+function getHierarchyClient(emitterOptions: RLCOptions) {
+  if (
+    emitterOptions.hierarchyClient === true ||
+    emitterOptions.hierarchyClient === false
+  ) {
+    return emitterOptions.hierarchyClient;
+  }
+  // enable hierarchy client by default if customers didn't set the option explicitly
+  return true;
+}
+
 function detectIfNameConflicts(dpgContext: SdkContext) {
   const clients = getRLCClients(dpgContext);
   const program = dpgContext.program;
-  const nameSet = new Set<string>();
   for (const client of clients) {
+    // only consider it's conflict when there are conflicts in the same client
+    const nameSet = new Set<string>();
     const operationGroups = listOperationGroups(dpgContext, client);
     for (const operationGroup of operationGroups) {
       const operations = listOperationsInOperationGroup(
@@ -181,6 +216,10 @@ function getIncludeShortcuts(emitterOptions: RLCOptions) {
   return Boolean(emitterOptions.includeShortcuts);
 }
 
+function getBranded(emitterOptions: RLCOptions) {
+  return emitterOptions.branded !== undefined ? emitterOptions.branded : true;
+}
+
 function getPackageDetails(
   program: Program,
   emitterOptions: RLCOptions
@@ -246,7 +285,7 @@ export function getCredentialInfo(
 ) {
   const securityInfo = processAuth(program);
   const addCredentials =
-    !securityInfo && emitterOptions.addCredentials === false
+    emitterOptions.addCredentials === false
       ? false
       : securityInfo
       ? securityInfo.addCredentials