@azure-tools/typespec-ts 0.23.0 → 0.25.0-alpha.20240311.1

package/src/modular/helpers/operationHelpers.ts

@@ -224,14 +224,14 @@ function getOperationSignatureParameters(
     });
 
   if (operation.bodyParameter) {
-    parameters.set(
-      operation.bodyParameter?.clientName,
-      buildType(
+    parameters.set(operation.bodyParameter?.clientName, {
+      hasQuestionToken: operation.bodyParameter.optional,
+      ...buildType(
         operation.bodyParameter.clientName,
         operation.bodyParameter.type,
         operation.bodyParameter.type.format
       )
-    );
+    });
   }
   // Add context as the first parameter
   const contextParam = { name: "context", type: clientType };
@@ -340,7 +340,10 @@ export function getOperationOptionsName(
       ? getClassicalLayerPrefix(operation, NameType.Interface)
       : "";
   const optionName = `${prefix}${toPascalCase(operation.name)}Options`;
-  if (operation.bodyParameter?.type.name === optionName) {
+  if (
+    operation.bodyParameter?.type.name === optionName ||
+    optionName === "ClientOptions"
+  ) {
     return optionName.replace(/Options$/, "RequestOptions");
   }
   return optionName;
@@ -462,7 +465,10 @@ function buildBodyParameter(
     );
 
     if (bodyParameter && bodyParts.length > 0) {
-      return `\nbody: {${bodyParts.join(",\n")}},`;
+      const optionalBody = bodyParameter.optional
+        ? `${bodyParameter.clientName} === undefined ? ${bodyParameter.clientName} : `
+        : "";
+      return `\nbody: ${optionalBody}{${bodyParts.join(",\n")}},`;
     } else if (bodyParameter && bodyParts.length === 0) {
       return `\nbody: ${bodyParameter.clientName},`;
     }
@@ -512,7 +518,7 @@ function buildBodyParameter(
   if (bodyParameter) {
     return `\nbody: ${bodyParameter.clientName},`;
   }
-  
+
   return "";
 }
 
@@ -963,6 +969,12 @@ export function deserializeResponseValue(
   typeStack: Type[] = [],
   format?: string
 ): string {
+  const requiredPrefix = required === false ? `${restValue} === undefined` : "";
+  const nullablePrefix = type.nullable ? `${restValue} === null` : "";
+  const requiredOrNullablePrefix =
+    requiredPrefix !== "" && nullablePrefix !== ""
+      ? `(${requiredPrefix} || ${nullablePrefix})`
+      : `${requiredPrefix}${nullablePrefix}`;
   switch (type.type) {
     case "datetime":
       return required
@@ -974,7 +986,7 @@ export function deserializeResponseValue(
       const prefix =
         required && !type.nullable
           ? `${restValue}`
-          : `!${restValue} ? ${restValue} : ${restValue}`;
+          : `${requiredOrNullablePrefix} ? ${restValue} : ${restValue}`;
       if (type.elementType?.type === "model") {
         if (!type.elementType.aliasType) {
           return `${prefix}.map(p => ({${getResponseMapping(
@@ -1049,6 +1061,13 @@ export function serializeRequestValue(
   typeStack: Type[] = [],
   format?: string
 ): string {
+  const requiredPrefix =
+    required === false ? `${clientValue} === undefined` : "";
+  const nullablePrefix = type.nullable ? `${clientValue} === null` : "";
+  const requiredOrNullablePrefix =
+    requiredPrefix !== "" && nullablePrefix !== ""
+      ? `(${requiredPrefix} || ${nullablePrefix})`
+      : `${requiredPrefix}${nullablePrefix}`;
   switch (type.type) {
     case "datetime":
       switch (type.format ?? format) {
@@ -1069,7 +1088,7 @@ export function serializeRequestValue(
       const prefix =
         required && !type.nullable
           ? `${clientValue}`
-          : `!${clientValue} ? ${clientValue} : ${clientValue}`;
+          : `${requiredOrNullablePrefix}? ${clientValue}: ${clientValue}`;
       if (type.elementType?.type === "model" && !type.elementType.aliasType) {
         return `${prefix}.map(p => ({${getRequestModelMapping(
           type.elementType,

package/src/modular/helpers/typeHelpers.ts

@@ -128,12 +128,18 @@ function handleConstantType(type: Type): TypeMetadata {
  * Handles the conversion of enum types to TypeScript representation metadata.
  */
 function handleEnumType(type: Type): TypeMetadata {
-  if (
-    !type.name &&
-    (!type?.valueType?.type ||
-      !["string", "number"].includes(type?.valueType?.type))
-  ) {
-    throw new Error("Unable to process enum without name");
+  if (!type.name) {
+    const valueType = !type.isFixed
+      ? ((type.values?.[0] as Type).valueType?.type ?? "string") + " | "
+      : "";
+    return {
+      name: `${valueType}${type.values
+        ?.map((e) => {
+          return getType(e as Type).name;
+        })
+        .join(" | ")}`,
+      nullable: type.nullable
+    };
   }
   const name = handleNullableTypeName({
     name: type.name,

package/src/transform/transform.ts

@@ -72,7 +72,11 @@ export async function transformRLCModel(
     client,
     dpgContext
   );
-  const helperDetails = transformHelperFunctionDetails(client, dpgContext);
+  const helperDetails = transformHelperFunctionDetails(
+    client,
+    dpgContext,
+    options.flavor
+  );
   // Enrich client-level annotation detail
   helperDetails.clientLroOverload = getClientLroOverload(paths);
   const urlInfo = transformUrlInfo(dpgContext);
@@ -92,7 +96,7 @@ export async function transformRLCModel(
     telemetryOptions,
     importInfo: {
       internalImports: importSet,
-      runtimeImports: buildRuntimeImports(options.branded)
+      runtimeImports: buildRuntimeImports(options.flavor)
     }
   };
   model.sampleGroups = transformSampleGroups(

package/src/transform/transformApiVersionInfo.ts

@@ -15,7 +15,7 @@ import {
 } from "@azure-tools/rlc-common";
 import { getHttpOperation } from "@typespec/http";
 import {
-  getEnrichedDefaultApiVersion,
+  getDefaultApiVersionString,
   getSchemaForType,
   trimUsage
 } from "../utils/modelUtils.js";
@@ -37,7 +37,7 @@ export function transformApiVersionInfo(
     pathVersionDetail?.isCrossedVersion || queryVersionDetail?.isCrossedVersion;
   const defaultValue =
     (pathVersionDetail || queryVersionDetail) && !isCrossedVersion
-      ? getEnrichedDefaultApiVersion(program, dpgContext) ??
+      ? getDefaultApiVersionString(program, dpgContext) ??
         pathVersionDetail?.defaultValue ??
         queryVersionDetail?.defaultValue
       : undefined;

package/src/transform/transformHelperFunctionDetails.ts

@@ -3,7 +3,7 @@ import {
   listOperationGroups,
   listOperationsInOperationGroup
 } from "@azure-tools/typespec-client-generator-core";
-import { HelperFunctionDetails } from "@azure-tools/rlc-common";
+import { HelperFunctionDetails, PackageFlavor } from "@azure-tools/rlc-common";
 import { ignoreDiagnostics, Model, Program, Type } from "@typespec/compiler";
 import { getHttpOperation, HttpOperation } from "@typespec/http";
 import {
@@ -19,7 +19,7 @@ import { SdkContext } from "../utils/interfaces.js";
 export function transformHelperFunctionDetails(
   client: SdkClient,
   dpgContext: SdkContext,
-  isBranded: boolean = true
+  flavor?: PackageFlavor
 ): HelperFunctionDetails {
   const program = dpgContext.program;
   const serializeInfo = extractSpecialSerializeInfo(
@@ -27,8 +27,8 @@ export function transformHelperFunctionDetails(
     client,
     dpgContext
   );
-  // Disbale paging and long running for non-branded clients.
-  if (!isBranded) {
+  // Disbale paging and long running for non-Azure clients.
+  if (flavor !== "azure") {
     return {
       hasLongRunning: false,
       hasPaging: false,

package/src/transform/transformParameters.ts

@@ -90,7 +90,7 @@ export function transformToParameterTypes(
     const parameters = route.parameters;
     const rlcParameter: OperationParameter = {
       operationGroup: getOperationGroupName(dpgContext, route),
-      operationName: getOperationName(program, route.operation),
+      operationName: getOperationName(dpgContext, route.operation),
       parameters: []
     };
     // transform query param

package/src/transform/transformPaths.ts

@@ -78,7 +78,7 @@ function transformOperation(
   for (const resp of sortedOperationResponses(route.responses)) {
     const respName = getResponseTypeName(
       operationGroupName,
-      getOperationName(program, route.operation),
+      getOperationName(dpgContext, route.operation),
       getOperationStatuscode(resp)
     );
     respNames.push(respName);
@@ -89,15 +89,15 @@ function transformOperation(
     hasOptionalOptions: !hasRequiredOptions(dpgContext, route.parameters),
     optionsName: getParameterTypeName(
       operationGroupName,
-      getOperationName(program, route.operation)
+      getOperationName(dpgContext, route.operation)
     ),
     responseTypes,
     returnType: respNames.join(" | "),
     successStatus: getOperationSuccessStatus(route),
-    operationName: getOperationName(program, route.operation),
+    operationName: getOperationName(dpgContext, route.operation),
     operationHelperDetail: {
       lroDetails: extractOperationLroDetail(
-        program,
+        dpgContext,
         route,
         responseTypes,
         operationGroupName
@@ -116,7 +116,7 @@ function transformOperation(
     paths[route.path] = {
       description: getDoc(program, route.operation) ?? "",
       name: escapeCoreName(
-        getOperationName(program, route.operation) || "Client"
+        getOperationName(dpgContext, route.operation) || "Client"
       ),
       pathParameters: route.parameters.parameters
         .filter((p) => p.type === "path")

package/src/transform/transformResponses.ts

@@ -75,7 +75,7 @@ export function transformToResponseTypes(
   function transformToResponseTypesForRoute(route: HttpOperation) {
     const rlcOperationUnit: OperationResponse = {
       operationGroup: getOperationGroupName(dpgContext, route),
-      operationName: getOperationName(program, route.operation),
+      operationName: getOperationName(dpgContext, route.operation),
       path: route.path,
       responses: []
     };
@@ -237,7 +237,7 @@ function transformLroLogicalResponse(
     description: `The final response for long-running ${route.operation.name} operation`,
     predefinedName: getLroLogicalResponseName(
       operationGroupName,
-      getOperationName(dpgContext.program, route.operation)
+      getOperationName(dpgContext, route.operation)
     ),
     body: successResp?.body
   };

package/src/transform/transfromRLCOptions.ts

@@ -2,6 +2,7 @@ import {
   NameType,
   normalizeName,
   PackageDetails,
+  PackageFlavor,
   RLCOptions,
   ServiceInfo
 } from "@azure-tools/rlc-common";
@@ -12,7 +13,7 @@ import {
   Program
 } from "@typespec/compiler";
 import { getAuthentication, getHttpOperation } from "@typespec/http";
-import { reportDiagnostic } from "../lib.js";
+import { EmitterOptions, reportDiagnostic } from "../lib.js";
 import { getDefaultService } from "../utils/modelUtils.js";
 import { getRLCClients } from "../utils/clientUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -24,7 +25,7 @@ import { getOperationName } from "../utils/operationUtil.js";
 import { detectModelConflicts } from "../utils/namespaceUtils.js";
 
 export function transformRLCOptions(
-  emitterOptions: RLCOptions,
+  emitterOptions: EmitterOptions,
   dpgContext: SdkContext
 ): RLCOptions {
   // Extract the options from emitter option
@@ -40,20 +41,20 @@ export function transformRLCOptions(
 
 function extractRLCOptions(
   dpgContext: SdkContext,
-  emitterOptions: RLCOptions,
+  emitterOptions: EmitterOptions,
   generationRootDir: string
 ): RLCOptions {
   const program = dpgContext.program;
   const includeShortcuts = getIncludeShortcuts(emitterOptions);
-  const branded = getBranded(emitterOptions);
   const packageDetails = getPackageDetails(program, emitterOptions);
+  const flavor = getFlavor(emitterOptions, packageDetails);
   const serviceInfo = getServiceInfo(program);
   const azureSdkForJs = getAzureSdkForJs(emitterOptions);
   const generateMetadata: undefined | boolean =
     getGenerateMetadata(emitterOptions);
   const generateTest: undefined | boolean = getGenerateTest(
     emitterOptions,
-    branded
+    flavor
   );
   const generateSample: undefined | boolean = getGenerateSample(emitterOptions);
   const credentialInfo = getCredentialInfo(program, emitterOptions);
@@ -70,7 +71,7 @@ function extractRLCOptions(
   return {
     ...emitterOptions,
     ...credentialInfo,
-    branded,
+    flavor,
     includeShortcuts,
     packageDetails,
     generateMetadata,
@@ -143,7 +144,7 @@ function processAuth(program: Program) {
 
 function getEnableOperationGroup(
   dpgContext: SdkContext,
-  emitterOptions: RLCOptions
+  emitterOptions: EmitterOptions
 ) {
   if (
     emitterOptions.enableOperationGroup === true ||
@@ -157,7 +158,7 @@ function getEnableOperationGroup(
 
 function getEnableModelNamespace(
   dpgContext: SdkContext,
-  emitterOptions: RLCOptions
+  emitterOptions: EmitterOptions
 ) {
   if (
     emitterOptions.enableModelNamespace === true ||
@@ -169,7 +170,7 @@ function getEnableModelNamespace(
   return detectModelConflicts(dpgContext);
 }
 
-function getHierarchyClient(emitterOptions: RLCOptions) {
+function getHierarchyClient(emitterOptions: EmitterOptions) {
   if (
     emitterOptions.hierarchyClient === true ||
     emitterOptions.hierarchyClient === false
@@ -189,7 +190,7 @@ function detectIfNameConflicts(dpgContext: SdkContext) {
     const clientOperations = listOperationsInOperationGroup(dpgContext, client);
     for (const clientOp of clientOperations) {
       const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
-      const name = getOperationName(program, route.operation);
+      const name = getOperationName(dpgContext, route.operation);
       if (nameSet.has(name)) {
         return true;
       } else {
@@ -204,7 +205,7 @@ function detectIfNameConflicts(dpgContext: SdkContext) {
       );
       for (const op of operations) {
         const route = ignoreDiagnostics(getHttpOperation(program, op));
-        const name = getOperationName(program, route.operation);
+        const name = getOperationName(dpgContext, route.operation);
         if (nameSet.has(name)) {
           return true;
         } else {
@@ -218,17 +219,43 @@ function detectIfNameConflicts(dpgContext: SdkContext) {
   return false;
 }
 
-function getIncludeShortcuts(emitterOptions: RLCOptions) {
+function getIncludeShortcuts(emitterOptions: EmitterOptions) {
   return Boolean(emitterOptions.includeShortcuts);
 }
 
-function getBranded(emitterOptions: RLCOptions) {
-  return emitterOptions.branded !== undefined ? emitterOptions.branded : true;
+function getFlavor(
+  emitterOptions: EmitterOptions,
+  packageDetails?: PackageDetails
+): PackageFlavor {
+  const flavor = emitterOptions.flavor;
+
+  if (flavor !== undefined) {
+    if (flavor.toLowerCase() === "azure") {
+      return "azure";
+    } else {
+      return undefined;
+    }
+  }
+
+  const branded = emitterOptions.branded;
+  if (branded !== undefined) {
+    return branded ? "azure" : undefined;
+  }
+
+  const scopeName = packageDetails?.scopeName;
+  if (
+    scopeName !== undefined &&
+    (scopeName.startsWith("azure") || scopeName.startsWith("msinternal"))
+  ) {
+    return "azure";
+  } else {
+    return undefined;
+  }
 }
 
 function getPackageDetails(
   program: Program,
-  emitterOptions: RLCOptions
+  emitterOptions: EmitterOptions
 ): PackageDetails {
   const packageDetails: PackageDetails = {
     ...emitterOptions.packageDetails,
@@ -264,14 +291,14 @@ function getServiceInfo(program: Program): ServiceInfo {
   };
 }
 
-function getAzureSdkForJs(emitterOptions: RLCOptions) {
+function getAzureSdkForJs(emitterOptions: EmitterOptions) {
   return emitterOptions.azureSdkForJs === undefined ||
     emitterOptions.azureSdkForJs === null
     ? true
     : Boolean(emitterOptions.azureSdkForJs);
 }
 
-function getGenerateMetadata(emitterOptions: RLCOptions) {
+function getGenerateMetadata(emitterOptions: EmitterOptions) {
   if (
     emitterOptions.generateMetadata === undefined ||
     emitterOptions.generateMetadata === null
@@ -286,15 +313,15 @@ function getGenerateMetadata(emitterOptions: RLCOptions) {
  * @param emitterOptions
  * @returns
  */
-function getGenerateTest(emitterOptions: RLCOptions, branded: boolean) {
+function getGenerateTest(emitterOptions: EmitterOptions, flavor?: "azure") {
   if (
-    !branded &&
+    flavor !== "azure" &&
     (emitterOptions.generateTest === undefined ||
       emitterOptions.generateTest === null)
   ) {
     return undefined;
   } else if (
-    branded &&
+    flavor === "azure" &&
     (emitterOptions.generateTest === undefined ||
       emitterOptions.generateTest === null)
   ) {
@@ -308,7 +335,7 @@ function getGenerateTest(emitterOptions: RLCOptions, branded: boolean) {
  * @param emitterOptions
  * @returns
  */
-function getGenerateSample(emitterOptions: RLCOptions) {
+function getGenerateSample(emitterOptions: EmitterOptions) {
   if (
     emitterOptions.generateSample === undefined ||
     emitterOptions.generateSample === null
@@ -320,7 +347,7 @@ function getGenerateSample(emitterOptions: RLCOptions) {
 
 export function getCredentialInfo(
   program: Program,
-  emitterOptions: RLCOptions
+  emitterOptions: EmitterOptions
 ) {
   const securityInfo = processAuth(program);
   const addCredentials =

package/src/utils/emitUtil.ts

@@ -8,14 +8,14 @@ import { prettierJSONOptions, prettierTypeScriptOptions } from "../lib.js";
 
 export async function emitModels(rlcModels: RLCModel, program: Program) {
   const schemaOutput = buildSchemaTypes(rlcModels);
-  const isBranded = rlcModels?.options?.branded ?? true;
+  const isAzureFlavor = rlcModels?.options?.flavor === "azure";
   if (schemaOutput) {
     const { inputModelFile, outputModelFile } = schemaOutput;
     if (inputModelFile) {
-      await emitFile(inputModelFile, program, isBranded);
+      await emitFile(inputModelFile, program, isAzureFlavor);
     }
     if (outputModelFile) {
-      await emitFile(outputModelFile, program, isBranded);
+      await emitFile(outputModelFile, program, isAzureFlavor);
     }
   }
 }
@@ -29,7 +29,7 @@ export async function emitContentByBuilder(
   if (!Array.isArray(builderFnOrList)) {
     builderFnOrList = [builderFnOrList];
   }
-  const isBranded = rlcModels?.options?.branded ?? true;
+  const isAzureFlavor = rlcModels?.options?.flavor === "azure";
   for (const builderFn of builderFnOrList) {
     let contentFiles: File[] | File | undefined = builderFn(rlcModels);
     if (!contentFiles) {
@@ -39,7 +39,7 @@ export async function emitContentByBuilder(
       contentFiles = [contentFiles];
     }
     for (const file of contentFiles) {
-      await emitFile(file, program, isBranded, emitterOutputDir);
+      await emitFile(file, program, isAzureFlavor, emitterOutputDir);
     }
   }
 }
@@ -47,14 +47,14 @@ export async function emitContentByBuilder(
 async function emitFile(
   file: File,
   program: Program,
-  isBranded: boolean,
+  isAzureFlavor: boolean,
   emitterOutputDir?: string
 ) {
   const host: CompilerHost = program.host;
   const filePath = join(emitterOutputDir ?? "", file.path);
   const isJson = /\.json$/gi.test(filePath);
   const isSourceCode = /\.(ts|js)$/gi.test(filePath);
-  const microsoftHeader = isBranded
+  const microsoftHeader = isAzureFlavor
     ? `// Copyright (c) Microsoft Corporation.\n`
     : "";
   const licenseHeader = `${microsoftHeader}// Licensed under the MIT license.\n`;