@azure-tools/typespec-ts 0.57.0-dev.6 → 0.57.0-dev.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.57.0-dev.6",
+  "version": "0.57.0-dev.7",
   "description": "A TypeSpec emitter for TypeScript",
   "main": "dist/src/index.js",
   "type": "module",
@@ -19,9 +19,9 @@
   "devDependencies": {
     "@azure-rest/core-client": "^2.7.0",
     "@azure-tools/azure-http-specs": "^0.1.0-alpha.44 || >= 0.1.0-alpha.45-dev.4",
-    "@azure-tools/typespec-autorest": "^0.71.0 || >= 0.72.0-dev.0",
-    "@azure-tools/typespec-azure-core": "^0.71.0 || >= 0.72.0-dev.0",
-    "@azure-tools/typespec-azure-resource-manager": "^0.71.0 || >= 0.72.0-dev.1",
+    "@azure-tools/typespec-autorest": "^0.71.0 || >= 0.72.0-dev.1",
+    "@azure-tools/typespec-azure-core": "^0.71.0 || >= 0.72.0-dev.1",
+    "@azure-tools/typespec-azure-resource-manager": "^0.71.0 || >= 0.72.0-dev.4",
     "@azure-tools/typespec-client-generator-core": "^0.71.2 || >= 0.72.0-dev.4",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
@@ -39,25 +39,25 @@
     "@microsoft/api-extractor": "^7.58.1",
     "@types/pluralize": "^0.0.33",
     "yaml": "^2.8.3",
-    "@typespec/http-specs": "^0.1.0-alpha.41",
     "@azure-tools/spector-runner": "^0.1.0",
     "@typespec/spector": "^0.1.0-alpha.28",
+    "@typespec/http-specs": "^0.1.0-alpha.41",
     "@typespec/spec-api": "^0.1.0-alpha.16",
     "@typespec/compiler": "^1.15.0",
     "@typespec/tspd": "^0.77.0",
     "@typespec/http": "^1.15.0",
     "@typespec/openapi": "^1.15.0",
+    "@typespec/rest": "^0.85.0",
     "@typespec/versioning": "^0.85.0",
-    "@typespec/xml": "^0.85.0",
-    "@typespec/rest": "^0.85.0"
+    "@typespec/xml": "^0.85.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.71.0 || >= 0.72.0-dev.0",
+    "@azure-tools/typespec-azure-core": "^0.71.0 || >= 0.72.0-dev.1",
     "@azure-tools/typespec-client-generator-core": "^0.71.2 || >= 0.72.0-dev.4",
     "@typespec/compiler": "^1.15.0",
-    "@typespec/http": "^1.15.0",
     "@typespec/rest": "^0.85.0",
     "@typespec/versioning": "^0.85.0",
+    "@typespec/http": "^1.15.0",
     "@typespec/xml": "^0.85.0"
   },
   "dependencies": {

package/src/lib.ts

@@ -483,6 +483,12 @@ const libDef = {
         default: paramMessage`Property name ${"propertyName"} is normalized to ${"normalizedName"}.`,
       },
     },
+    "invalid-exact-name": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`Exact ${"nameKind"} name ${"name"} is not a valid TypeScript identifier. Choose a valid TypeScript identifier or remove exact().`,
+      },
+    },
     "un-supported-format-cases": {
       severity: "warning",
       messages: {

package/src/modular/build-classical-client.ts

@@ -21,7 +21,7 @@ import { resolveReference } from "../framework/reference.js";
 import { refkey } from "../framework/refkey.js";
 import { getClientModuleInfo } from "../utils/client-utils.js";
 import type { SdkContext } from "../utils/interfaces.js";
-import { NameType, normalizeName } from "../utils/name-utils.js";
+import { NameType, normalizeName, normalizeSdkName } from "../utils/name-utils.js";
 import { getMethodHierarchiesMap, isTenantLevelOperation } from "../utils/operation-util.js";
 import { AzurePollingDependencies } from "./external-dependencies.js";
 import { getPagingLROMethodName } from "./helpers/classical-operation-helpers.js";
@@ -137,9 +137,14 @@ export function buildClassicalClient(
       `this._clientParams = {${classicalParams.map((p) => p.name).join(",")}};`,
     );
     for (const childClient of client.children) {
-      const subfolder = normalizeName(childClient.name.replace("Client", ""), NameType.File);
+      const subfolder = normalizeSdkName(childClient, NameType.File, {
+        nameOverride: childClient.name.replace(/Client$/, ""),
+      });
       clientFile.addImportDeclaration({
-        moduleSpecifier: `./${subfolder}/${normalizeName(childClient.name, NameType.File)}.js`,
+        moduleSpecifier: `./${subfolder}/${normalizeName(
+          getClassicalClientName(childClient),
+          NameType.File,
+        )}.js`,
         namedImports: [
           `${getClassicalClientName(childClient)}`,
           `${getClassicalClientName(childClient)}OptionalParams`,
@@ -275,11 +280,9 @@ function buildClientOperationGroups(
       const operationName = `_get${rawGroupName}Operations`;
       const propertyType = `${rawGroupName}Operations`;
       // The `groupName` is used to any places where we don't need normalized name again
-      const groupName = normalizeName(rawGroupName, NameType.Property);
-      const existProperty = clientClass.getProperties().filter((p) => {
-        return p.getName() === normalizeName(groupName, NameType.Property);
-      });
-      if (!existProperty || existProperty.length === 0) {
+      const groupName = normalizeName(prefixes[0] ?? "", NameType.Property);
+      const existingProperty = clientClass.getProperty(groupName);
+      if (!existingProperty) {
         clientClass.addProperty({
           name: groupName,
           type: resolveReference(refkey(client, propertyType, layer, "classicOperations")),

package/src/modular/build-operations.ts

@@ -24,7 +24,7 @@ import { resolveReference } from "../framework/reference.js";
 import { refkey } from "../framework/refkey.js";
 import { getClientModuleInfo } from "../utils/client-utils.js";
 import type { SdkContext } from "../utils/interfaces.js";
-import { NameType, normalizeName } from "../utils/name-utils.js";
+import { NameType, normalizeName, normalizeSdkName } from "../utils/name-utils.js";
 import {
   getMethodHierarchiesMap,
   hasDualFormatSupport,
@@ -186,7 +186,7 @@ export function buildOperationOptions(
           docs: getDocsFromDescription(p.doc),
           hasQuestionToken: true,
           type: getTypeExpression(context, p.type, { isOptional: true }),
-          name: normalizeName(p.name, NameType.Parameter),
+          name: normalizeSdkName(p, NameType.Parameter),
         };
       }),
     ),

package/src/modular/build-root-index.ts

@@ -278,7 +278,7 @@ function exportClassicalClient(
   subfolder: string,
   isSubClient: boolean = false,
 ) {
-  const clientName = client.name;
+  const clientName = getClassicalClientName(client);
   enqueueStatement(indexFile, {
     kind: StructureKind.ExportDeclaration,
     namedExports: [clientName],

package/src/modular/emit-models.ts

@@ -51,7 +51,14 @@ import { reportDiagnostic } from "../lib.js";
 import { getClientHierarchyMap } from "../utils/client-utils.js";
 import type { SdkContext } from "../utils/interfaces.js";
 import { isAzureCoreErrorType } from "../utils/model-utils.js";
-import { fixLeadingNumber, NameType, normalizeName } from "../utils/name-utils.js";
+import {
+  fixLeadingNumber,
+  formatPropertyName,
+  NameType,
+  normalizeName,
+  normalizeSdkName,
+  reportInvalidExactName,
+} from "../utils/name-utils.js";
 import { getMethodHierarchiesMap } from "../utils/operation-util.js";
 import { getHeaderClientOptions } from "./helpers/client-option-helpers.js";
 import {
@@ -620,11 +627,15 @@ function emitEnumMember(
   member: SdkEnumValueType,
   reportMemberNameDiagnostic = false, // if reportMemberNameDiagnostic is true, it will report diagnostic for enum member name
 ): EnumMemberStructure {
-  const shouldNormalizeName = !member.name.startsWith("$DO_NOT_NORMALIZE$");
-  const enumTypeName = normalizeName(member.enumType.name, NameType.Interface, true);
-  let normalizedMemberName = context.emitterOptions?.ignoreEnumMemberNameNormalize
-    ? fixLeadingNumber(member.name, NameType.EnumMemberName) // need to fix the leading number also for enum member
-    : normalizeName(member.name, NameType.EnumMemberName, true);
+  const shouldNormalizeName = !member.isExactName && !member.name.startsWith("$DO_NOT_NORMALIZE$");
+  const enumTypeName = normalizeSdkName(member.enumType, NameType.Interface, {
+    shouldGuard: true,
+  });
+  let normalizedMemberName = member.isExactName
+    ? formatPropertyName(member.name)
+    : context.emitterOptions?.ignoreEnumMemberNameNormalize
+      ? fixLeadingNumber(member.name, NameType.EnumMemberName) // need to fix the leading number also for enum member
+      : normalizeSdkName(member, NameType.EnumMemberName, { shouldGuard: true });
   // If the member name starts with _ due to a leading digit (not because the original has _),
   // replace the _ prefix with either "V" (for API version enums) or the enum type name.
   if (
@@ -846,6 +857,8 @@ export function normalizeModelName(
     return getTypeExpression(context, type);
   }
 
+  reportInvalidExactName(context.program, type, nameType, type.kind, type.__raw ?? NoTarget);
+
   const segments = getModelNamespaces(context, type);
   let unionSuffix = "";
   if (!skipPolymorphicUnionSuffix) {
@@ -853,12 +866,15 @@ export function normalizeModelName(
       unionSuffix = "Union";
     }
   }
-  const namespacePrefix = context.emitterOptions?.enableModelNamespace ? segments.join("") : "";
+  const namespacePrefix = context.emitterOptions?.enableModelNamespace
+    ? normalizeName(segments.join(""), nameType)
+    : "";
   const internalModelPrefix =
     (isPagedResultModel(context, type) && !pagedModelsKeptPublic.has(type)) || type.isGeneratedName
       ? "_"
       : "";
-  return `${internalModelPrefix}${normalizeName(namespacePrefix + type.name, nameType, true)}${unionSuffix}`;
+  const modelName = normalizeSdkName(type, nameType, { shouldGuard: true });
+  return `${internalModelPrefix}${namespacePrefix}${modelName}${unionSuffix}`;
 }
 
 function buildModelPolymorphicType(context: SdkContext, type: SdkModelType) {
@@ -898,6 +914,7 @@ function buildModelProperty(
   const normalizedPropName = normalizeModelPropertyName(context, property);
   if (
     !context.emitterOptions?.ignorePropertyNameNormalize &&
+    !property.isExactName &&
     normalizedPropName !== `"${property.name}"`
   ) {
     reportDiagnostic(context.program, {

package/src/modular/emit-samples.ts

@@ -17,7 +17,14 @@ import { AzureIdentityDependencies } from "../modular/external-dependencies.js";
 import { getSubscriptionId } from "../transform/transform-client-options.js";
 import { hasKeyCredential, hasTokenCredential } from "../utils/credential-utils.js";
 import type { SdkContext } from "../utils/interfaces.js";
-import { NameType, normalizeName } from "../utils/name-utils.js";
+import {
+  formatPropertyName,
+  NameType,
+  normalizeName,
+  normalizeSdkName,
+  normalizeSdkPropertyName,
+  type SdkName,
+} from "../utils/name-utils.js";
 import {
   getMethodHierarchiesMap,
   isTenantLevelOperation,
@@ -61,10 +68,7 @@ export function emitSamples(dpgContext: SdkContext): SourceFile[] {
     emitClientSamples(dpgContext, client, {
       topLevelClient: client,
       generatedFiles,
-      subFolder:
-        clients.length > 1
-          ? normalizeName(getClassicalClientName(client), NameType.File)
-          : undefined,
+      subFolder: clients.length > 1 ? normalizeSdkName(client, NameType.File) : undefined,
     });
   }
   return generatedFiles;
@@ -193,9 +197,9 @@ function emitMethodSamples(
     }
     const prefix = options.classicalMethodPrefix ? `${options.classicalMethodPrefix}.` : "";
     const isPaging = method.kind === "paging";
-    const methodCall = `client.${prefix}${normalizeName(method.oriName ?? method.name, NameType.Property)}(${methodParams.join(
-      ", ",
-    )})`;
+    const methodCall = `client.${prefix}${normalizeSdkName(method, NameType.Property, {
+      nameOverride: method.oriName ?? method.name,
+    })}(${methodParams.join(", ")})`;
     if (isPaging) {
       exampleFunctionBody.push(`const resArray = new Array();`);
       exampleFunctionBody.push(`for await (const item of ${methodCall}) { resArray.push(item); }`);
@@ -244,13 +248,14 @@ function buildParameterValueMap(example: SdkHttpOperationExample) {
 
 function prepareExampleValue(
   context: SdkContext,
-  name: string,
+  name: string | SdkName,
   value: SdkExampleValue | string,
   isOptional?: boolean,
   onClient?: boolean,
 ): ExampleValue {
+  const sdkName = typeof name === "string" ? { name } : name;
   return {
-    name: normalizeName(name, NameType.Parameter, true),
+    name: normalizeSdkName(sdkName, NameType.Parameter, { shouldGuard: true }),
     value: typeof value === "string" ? value : getParameterValue(context, value),
     isOptional: Boolean(isOptional),
     onClient: Boolean(onClient),
@@ -356,13 +361,7 @@ function prepareExampleParameters(
         subscriptionIdValue = getParameterValue(dpgContext, exampleValue.value);
       }
       result.push(
-        prepareExampleValue(
-          dpgContext,
-          param.name,
-          subscriptionIdValue,
-          param.optional,
-          param.onClient,
-        ),
+        prepareExampleValue(dpgContext, param, subscriptionIdValue, param.optional, param.onClient),
       );
       continue;
     }
@@ -413,7 +412,8 @@ function prepareExampleParameters(
       bodyExample.value.kind === "model"
     ) {
       for (const prop of bodyParam.type.properties) {
-        const propExample = bodyExample.value.value[prop.name];
+        const wireName = prop.serializationOptions.json?.name ?? prop.name;
+        const propExample = bodyExample.value.value[wireName] ?? bodyExample.value.value[prop.name];
         if (!propExample) {
           continue;
         }
@@ -422,7 +422,7 @@ function prepareExampleParameters(
           continue;
         }
         result.push(
-          prepareExampleValue(dpgContext, prop.name, propExample, prop.optional, prop.onClient),
+          prepareExampleValue(dpgContext, prop, propExample, prop.optional, prop.onClient),
         );
       }
     } else {
@@ -433,18 +433,17 @@ function prepareExampleParameters(
       if (isNestedBody) {
         const path = segments[0]!;
         // The first segment is the method-level wrapper param (e.g., "body")
-        const methodParamName = path[0]!.name;
         const methodParamOptional = path[0]!.optional;
         // Wrap the example value with the intermediate property names
         let wrappedValue = getParameterValue(dpgContext, bodyExample.value);
         for (let i = path.length - 1; i >= 1; i--) {
-          const propName = normalizeName(path[i]!.name, NameType.Property, true);
+          const propName = formatPropertyName(normalizeSdkPropertyName(path[i]!));
           wrappedValue = `{ ${propName}: ${wrappedValue} }`;
         }
         result.push(
           prepareExampleValue(
             dpgContext,
-            methodParamName,
+            path[0]!,
             wrappedValue,
             methodParamOptional,
             bodyParam.onClient,
@@ -454,7 +453,7 @@ function prepareExampleParameters(
         result.push(
           prepareExampleValue(
             dpgContext,
-            bodyParam.name,
+            bodyParam,
             bodyExample.value,
             bodyParam.optional,
             bodyParam.onClient,
@@ -467,7 +466,7 @@ function prepareExampleParameters(
   // a scalar value; a parameter with nested leaves carries an object literal.
   for (const arg of methodArguments.values()) {
     result.push({
-      name: normalizeName(arg.name, NameType.Parameter, true),
+      name: normalizeSdkName(arg, NameType.Parameter, { shouldGuard: true }),
       value: serializeNestedValue(arg.value),
       isOptional: arg.isOptional,
       onClient: false,
@@ -491,15 +490,20 @@ interface ValueTreeNode {
 function placeMethodArgument(
   methodArguments: Map<
     string,
-    { name: string; isOptional: boolean; value: ValueTreeNode | string }
+    { name: string; isExactName?: boolean; isOptional: boolean; value: ValueTreeNode | string }
   >,
-  path: readonly { name: string; optional?: boolean }[],
+  path: readonly { name: string; isExactName?: boolean; optional?: boolean }[],
   leaf: string,
 ): void {
   const root = path[0]!;
   let arg = methodArguments.get(root.name);
   if (!arg) {
-    arg = { name: root.name, isOptional: Boolean(root.optional), value: {} };
+    arg = {
+      name: root.name,
+      isExactName: root.isExactName,
+      isOptional: Boolean(root.optional),
+      value: {},
+    };
     methodArguments.set(root.name, arg);
   }
   if (path.length === 1) {
@@ -515,12 +519,12 @@ function placeMethodArgument(
 /** Places `leaf` at `path` (segments after the root), creating intermediate objects as needed. */
 function setNestedValue(
   root: ValueTreeNode,
-  path: readonly { name: string }[],
+  path: readonly { name: string; isExactName?: boolean }[],
   leaf: string,
 ): void {
   let node = root;
   for (let i = 0; i < path.length; i++) {
-    const key = normalizeName(path[i]!.name, NameType.Property, true);
+    const key = normalizeSdkPropertyName(path[i]!);
     if (i === path.length - 1) {
       node[key] = leaf;
     } else {
@@ -539,7 +543,7 @@ function serializeNestedValue(node: ValueTreeNode | string): string {
     return node;
   }
   const entries = Object.entries(node).map(
-    ([key, value]) => `${key}: ${serializeNestedValue(value)}`,
+    ([key, value]) => `${formatPropertyName(key)}: ${serializeNestedValue(value)}`,
   );
   return `{ ${entries.join(", ")} }`;
 }
@@ -635,7 +639,10 @@ function getParameterValue(
       }) {
         let property;
         if (value.type.kind === "model") {
-          property = value.type.properties.find((p) => p.name === propName);
+          property =
+            value.type.properties.find(
+              (p) => (p.serializationOptions.json?.name ?? p.name) === propName,
+            ) ?? value.type.properties.find((p) => p.name === propName);
         }
         const propValue = value.value[propName];
         if (propValue === undefined || propValue === null) {
@@ -668,7 +675,7 @@ function getParameterValue(
           // so that independent inner flattens at deeper levels still work.
           const childOptions = options?.overrides?.enableFlatten === false ? undefined : options;
           propRetValue =
-            `"${mapper.get(propName) ?? propName}": ` +
+            `${JSON.stringify(mapper.get(propName) ?? propName)}: ` +
             getParameterValue(context, propValue, childOptions);
         }
         if (propRetValue) values.push(propRetValue);
@@ -682,14 +689,15 @@ function getParameterValue(
           continue;
         }
         const propRetValue =
-          `"${mapper.get(propName) ?? propName}": ` + getParameterValue(context, propValue);
+          `${JSON.stringify(mapper.get(propName) ?? propName)}: ` +
+          getParameterValue(context, propValue);
         additionalBags.push(propRetValue);
       }
       if (additionalBags.length > 0) {
         const name = mapper.get("additionalProperties")
           ? "additionalPropertiesBag"
           : "additionalProperties";
-        values.push(`"${name}": {
+        values.push(`${JSON.stringify(name)}: {
           ${additionalBags.join(", ")}
           }`);
       }

package/src/modular/emit-tests.ts

@@ -2,7 +2,7 @@ import { type CompilerHost, joinPaths } from "@typespec/compiler";
 import { SourceFile } from "ts-morph";
 import { resolveReference } from "../framework/reference.js";
 import type { SdkContext } from "../utils/interfaces.js";
-import { NameType, normalizeName } from "../utils/name-utils.js";
+import { NameType, normalizeName, normalizeSdkName } from "../utils/name-utils.js";
 import type { ServiceOperation } from "../utils/operation-util.js";
 import { AzureTestDependencies } from "./external-dependencies.js";
 import {
@@ -41,7 +41,7 @@ async function cleanupTestFolder(dpgContext: SdkContext, host: CompilerHost) {
   // If there are multiple clients, clean up subfolders
   if (clients.length > 1) {
     for (const client of clients) {
-      const subFolder = normalizeName(getClassicalClientName(client), NameType.File);
+      const subFolder = normalizeSdkName(client, NameType.File);
       const clientTestFolder = joinPaths(baseTestFolder, subFolder);
       if (await dirExists(clientTestFolder)) {
         await host.rm(clientTestFolder, { recursive: true });

package/src/modular/helpers/classical-operation-helpers.ts

@@ -15,7 +15,7 @@ import { resolveReference } from "../../framework/reference.js";
 import { refkey } from "../../framework/refkey.js";
 import { getClientModuleInfo } from "../../utils/client-utils.js";
 import type { SdkContext } from "../../utils/interfaces.js";
-import { NameType, normalizeName } from "../../utils/name-utils.js";
+import { NameType, normalizeName, normalizeSdkName } from "../../utils/name-utils.js";
 import type { ServiceOperation } from "../../utils/operation-util.js";
 import { AzurePollingDependencies } from "../external-dependencies.js";
 import { PagingHelpers, SimplePollerHelpers } from "../static-helpers-metadata.js";
@@ -25,8 +25,7 @@ import { getOperationFunction } from "./operation-helpers.js";
 interface OperationDeclarationInfo {
   // the operation function
   declaration: OptionalKind<FunctionDeclarationStructure>;
-  // the original operation name
-  oriName: string | undefined;
+  operation: ServiceOperation;
   // the refkey of the operation declaration
   declarationRefKey: string | undefined;
   // the default is false
@@ -85,7 +84,7 @@ export function getClassicalOperation(
       const declaration = getOperationFunction(dpgContext, [prefixes, operation], clientName);
       operationDeclarationMap.set(declaration, {
         declaration,
-        oriName: operation.oriName,
+        operation,
         declarationRefKey: resolveReference(refkey(operation, "api")),
         isLro: declaration.isLro,
         lroFinalReturnType: declaration.lroFinalReturnType,
@@ -370,12 +369,11 @@ export function getClassicalOperation(
       propertyName?: string;
     },
   ) {
-    return normalizeName(
-      operationDeclarationMap.get(declaration)?.oriName ??
-        declaration.propertyName ??
-        declaration.name ??
-        "FIXME",
-      NameType.Method,
-    );
+    const operationInfo = operationDeclarationMap.get(declaration);
+    const name =
+      operationInfo?.operation.oriName ?? declaration.propertyName ?? declaration.name ?? "FIXME";
+    return normalizeSdkName(operationInfo?.operation ?? { name }, NameType.Method, {
+      nameOverride: name,
+    });
   }
 }

package/src/modular/helpers/client-helpers.ts

@@ -16,7 +16,7 @@ import type { ModularEmitterOptions } from "../interfaces.js";
 
 import { resolveReference } from "../../framework/reference.js";
 import type { SdkContext } from "../../utils/interfaces.js";
-import { NameType, normalizeName } from "../../utils/name-utils.js";
+import { NameType, normalizeSdkName } from "../../utils/name-utils.js";
 import { CloudSettingHelpers } from "../static-helpers-metadata.js";
 import { getTypeExpression } from "../type-expressions/get-type-expression.js";
 import { getClassicalClientName } from "./naming-helpers.js";
@@ -154,15 +154,16 @@ function getClientParameterTypeExpression(context: SdkContext, parameter: SdkPar
 export function getClientParameterName(parameter: SdkParameter) {
   // We have been calling this endpointParam, so special handling this here to make sure there are no unexpected side effects
   if (
-    (parameter.type.kind === "union" &&
+    !parameter.isExactName &&
+    ((parameter.type.kind === "union" &&
       parameter.type.variantTypes.some((v) => v.kind === "endpoint")) ||
-    ((parameter.kind === "endpoint" || parameter.kind === "path") &&
-      parameter.name.toLowerCase() === "endpoint")
+      ((parameter.kind === "endpoint" || parameter.kind === "path") &&
+        parameter.name.toLowerCase() === "endpoint"))
   ) {
     return "endpointParam";
   }
 
-  return normalizeName(parameter.name, NameType.Parameter, true);
+  return normalizeSdkName(parameter, NameType.Parameter, { shouldGuard: true });
 }
 
 export function buildGetClientEndpointParam(