@azure-tools/typespec-ts 0.52.2 → 0.52.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -18,15 +18,15 @@
   "license": "MIT",
   "devDependencies": {
     "@azure-rest/core-client": "^2.3.1",
-    "@typespec/http-specs": "0.1.0-alpha.36-dev.3",
-    "@typespec/spector": "0.1.0-alpha.25-dev.5",
-    "@typespec/spec-api": "0.1.0-alpha.14-dev.4",
+    "@typespec/http-specs": "0.1.0-alpha.37-dev.3",
+    "@typespec/spector": "0.1.0-dev.4",
+    "@typespec/spec-api": "0.1.0-dev.3",
     "@typespec/tspd": "0.74.1",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.40-dev.4",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.40-dev.6",
     "@azure-tools/typespec-autorest": "^0.67.0",
-    "@azure-tools/typespec-azure-core": "^0.67.0",
+    "@azure-tools/typespec-azure-core": "^0.67.1",
     "@azure-tools/typespec-azure-resource-manager": "^0.67.1",
-    "@azure-tools/typespec-client-generator-core": "^0.67.2",
+    "@azure-tools/typespec-client-generator-core": "^0.67.3",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
     "@azure/core-lro": "^3.1.0",
@@ -63,8 +63,8 @@
     "js-yaml": "^4.1.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.67.0",
-    "@azure-tools/typespec-client-generator-core": "^0.67.2",
+    "@azure-tools/typespec-azure-core": "^0.67.1",
+    "@azure-tools/typespec-client-generator-core": "^0.67.3",
     "@typespec/compiler": "^1.11.0",
     "@typespec/http": "^1.11.0",
     "@typespec/rest": "^0.81.0",
@@ -72,7 +72,7 @@
     "@typespec/xml": "^0.81.0"
   },
   "dependencies": {
-    "@azure-tools/rlc-common": "^0.52.2",
+    "@azure-tools/rlc-common": "^0.52.3",
     "fast-xml-parser": "^4.5.0",
     "fs-extra": "^11.1.0",
     "lodash": "^4.17.21",

package/src/framework/hooks/sdkTypes.ts

@@ -23,6 +23,11 @@ import { NameType, normalizeName } from "@azure-tools/rlc-common";
 export const emitQueue: Set<SdkType> = new Set<SdkType>();
 export const flattenPropertyModelMap: Map<SdkModelPropertyType, SdkModelType> =
   new Map<SdkModelPropertyType, SdkModelType>();
+/**
+ * Set of paged result models that are also used in non-paging operations.
+ * Precomputed during visitPackageTypes for O(1) lookups in normalizeModelName.
+ */
+export const pagedModelsUsedInNonPagingOps = new Set<SdkType>();
 
 export interface SdkTypeContext {
   operations: Map<Type, SdkServiceMethod<SdkHttpOperation>>;

package/src/index.ts

@@ -34,6 +34,7 @@ import {
   buildIndexFile,
   buildIsUnexpectedHelper,
   buildLicenseFile,
+  buildChangelogFile,
   buildLogger,
   buildPackageFile,
   buildParameterTypes,
@@ -101,7 +102,7 @@ import {
   getRLCClients,
   getModularClientOptions
 } from "./utils/clientUtils.js";
-import { join } from "path";
+import { basename, join } from "path";
 import { loadStaticHelpers } from "./framework/load-static-helpers.js";
 import { packageUsesXmlSerialization } from "./modular/serialization/buildXmlSerializerFunction.js";
 import { provideBinder } from "./framework/hooks/binder.js";
@@ -450,6 +451,13 @@ export async function $onEmit(context: EmitContext) {
     }
     const rlcClient: RLCModel = rlcCodeModels[0];
     const option = dpgContext.rlcOptions!;
+    // When generateMetadata is explicitly false and the sources are generated
+    // into a path ending with "generated" (e.g. src/generated), this package
+    // has a manual convenience layer. Skip all metadata/test file generation
+    // to avoid unexpected modifications to files like package.json, README.md,
+    // warp.config.yml, and snippets.spec.ts. metadata.json is still updated.
+    const sourcesDir = dpgContext.generationPathDetail?.modularSourcesDir ?? "";
+    const hasManualConvenienceLayer = basename(sourcesDir) === "generated";
     const isAzureFlavor = isAzurePackage({ options: option });
     // Generate metadata
     const existingPackageFilePath = join(
@@ -462,6 +470,11 @@ export async function $onEmit(context: EmitContext) {
       "README.md"
     );
     const hasReadmeFile = await existsSync(existingReadmeFilePath);
+    const existingChangelogFilePath = join(
+      dpgContext.generationPathDetail?.metadataDir ?? "",
+      "CHANGELOG.md"
+    );
+    const hasChangelogFile = await existsSync(existingChangelogFilePath);
     const shouldGenerateMetadata =
       option.generateMetadata === true || !hasPackageFile;
     const existingTestFolderPath = join(
@@ -503,6 +516,9 @@ export async function $onEmit(context: EmitContext) {
       if (isAzureFlavor) {
         commonBuilders.push(buildEsLintConfig);
       }
+      if (!hasChangelogFile) {
+        commonBuilders.push(buildChangelogFile);
+      }
       if (
         emitterOptions["generate-test"] === true &&
         option.azureSdkForJs === true &&
@@ -584,7 +600,7 @@ export async function $onEmit(context: EmitContext) {
           );
         }
       }
-    } else if (hasPackageFile) {
+    } else if (hasPackageFile && !hasManualConvenienceLayer) {
       const updateBuilders = [];
       let modularPackageInfo = {};
 

package/src/modular/buildProjectFiles.ts

@@ -2,7 +2,7 @@ import { NameType } from "@azure-tools/rlc-common";
 
 import { ModularEmitterOptions } from "./interfaces.js";
 import { getClassicalLayerPrefix } from "./helpers/namingHelpers.js";
-import { SdkContext } from "@azure-tools/typespec-client-generator-core";
+import { SdkContext } from "../utils/interfaces.js";
 import {
   getClientHierarchyMap,
   getModularClientOptions
@@ -11,11 +11,39 @@ import { getMethodHierarchiesMap } from "../utils/operationUtil.js";
 import { useContext } from "../contextManager.js";
 import path from "path/posix";
 
+/**
+ * Computes the relative path prefix (e.g. `./src` or `./src/generated`) from
+ * the project root to the modular sources directory.  This prefix is used when
+ * building export map entries so that they always point to the correct folder
+ * even when the generated code lives under `src/generated` instead of `src`.
+ */
+function getSourceRootPrefix(
+  emitterOptions: ModularEmitterOptions,
+  context: SdkContext
+): string {
+  const sourceRoot = emitterOptions.modularOptions.sourceRoot.replace(
+    /\\/g,
+    "/"
+  );
+  const rootDir = (context.generationPathDetail?.rootDir ?? "").replace(
+    /\\/g,
+    "/"
+  );
+
+  if (rootDir && sourceRoot.startsWith(rootDir)) {
+    const relativePath = path.relative(rootDir, sourceRoot).replace(/\\/g, "/");
+    return `./${relativePath}`;
+  }
+
+  return "./src";
+}
+
 function buildExportsForMultiClient(
   context: SdkContext,
   emitterOptions: ModularEmitterOptions,
   packageInfo: any
 ) {
+  const srcPrefix = getSourceRootPrefix(emitterOptions, context);
   const clientMap = getClientHierarchyMap(context);
   let hasTopLevelClient = false;
   for (const [hierarchy, client] of clientMap) {
@@ -25,10 +53,11 @@ function buildExportsForMultiClient(
     }
     const { subfolder } = getModularClientOptions([hierarchy, client]);
     if (subfolder !== "" && methodMap.size > 0) {
-      packageInfo.exports[`./${subfolder}`] = `./src/${subfolder}/index.ts`;
+      packageInfo.exports[`./${subfolder}`] =
+        `${srcPrefix}/${subfolder}/index.ts`;
 
       packageInfo.exports[`./${subfolder}/api`] =
-        `./src/${subfolder}/api/index.ts`;
+        `${srcPrefix}/${subfolder}/api/index.ts`;
     }
   }
   if (!hasTopLevelClient) {
@@ -51,9 +80,11 @@ function buildExportsForMultiClient(
             NameType.File,
             "/"
           )}`;
+
           packageInfo.exports[
             `./${subfolder ? subfolder + "/" : ""}${subApiPath}`
-          ] = `src/${subfolder ? subfolder + "/" : ""}${subApiPath}/index.ts`;
+          ] =
+            `${srcPrefix}/${subfolder ? subfolder + "/" : ""}${subApiPath}/index.ts`;
         }
       }
     }
@@ -61,7 +92,7 @@ function buildExportsForMultiClient(
     const modelSubpaths = getModelSubpaths(emitterOptions);
     for (const modelSubpath of modelSubpaths) {
       packageInfo.exports[`./${modelSubpath.replace("/index.ts", "")}`] =
-        `./src/${modelSubpath}`;
+        `${srcPrefix}/${modelSubpath}`;
     }
   }
 
@@ -72,13 +103,14 @@ export function getModuleExports(
   context: SdkContext,
   emitterOptions: ModularEmitterOptions
 ) {
+  const srcPrefix = getSourceRootPrefix(emitterOptions, context);
   const exports: Record<string, any> = {
     exports: {
-      ".": "./src/index.ts",
-      "./models": "./src/models/index.ts"
+      ".": `${srcPrefix}/index.ts`,
+      "./models": `${srcPrefix}/models/index.ts`
     }
   };
-  exports["exports"]["./api"] = "./src/api/index.ts";
+  exports["exports"]["./api"] = `${srcPrefix}/api/index.ts`;
 
   return buildExportsForMultiClient(context, emitterOptions, exports);
 }

package/src/modular/emitModels.ts

@@ -78,7 +78,8 @@ import {
 import {
   emitQueue,
   flattenPropertyModelMap,
-  getAllOperationsFromClient
+  getAllOperationsFromClient,
+  pagedModelsUsedInNonPagingOps
 } from "../framework/hooks/sdkTypes.js";
 import {
   getAllAncestors,
@@ -746,12 +747,15 @@ function buildModelInterface(
         if (!hasInputUsage && p.__raw && isMetadata(context.program, p.__raw)) {
           return false;
         }
-        // Skip required metadata properties with Read visibility for ARM as they are not intended to be in the model
+        // Skip required metadata properties with Read-only visibility for ARM as they are not intended to be in the model
         // These properties are not be generated no matter they are in input or output models in most cases in HLC
+        // Only skip properties that have exclusively Read visibility to avoid stripping @path properties
+        // on parameter bag models that also carry other visibility flags (e.g. Create/Update)
         if (
           context.arm &&
           p.__raw &&
           isMetadata(context.program, p.__raw) &&
+          p.visibility?.length === 1 &&
           p.visibility?.includes(Visibility.Read)
         ) {
           return false;
@@ -945,7 +949,11 @@ export function normalizeModelName(
     ? segments.join("")
     : "";
   const internalModelPrefix =
-    isPagedResultModel(context, type) || type.isGeneratedName ? "_" : "";
+    (isPagedResultModel(context, type) &&
+      !pagedModelsUsedInNonPagingOps.has(type)) ||
+    type.isGeneratedName
+      ? "_"
+      : "";
   return `${internalModelPrefix}${normalizeName(namespacePrefix + type.name, nameType, true)}${unionSuffix}`;
 }
 
@@ -1038,6 +1046,7 @@ export function visitPackageTypes(context: SdkContext) {
   const { sdkPackage } = context;
   emitQueue.clear();
   flattenPropertyModelMap.clear();
+  pagedModelsUsedInNonPagingOps.clear();
   // Add all models in the package to the emit queue
   for (const model of sdkPackage.models) {
     visitType(context, model);
@@ -1119,6 +1128,22 @@ function visitMethod(
     visitType(context, parameter.type);
   });
   visitType(context, method.response.type);
+  trackPagedModelInNonPagingMethod(context, method);
+}
+
+/**
+ * If a non-paging method's direct response type is a paged result model,
+ * mark it so that normalizeModelName keeps it public (no "_" prefix).
+ */
+function trackPagedModelInNonPagingMethod(
+  context: SdkContext,
+  method: SdkServiceMethod<SdkHttpOperation>
+): void {
+  if (method.kind !== "basic" && method.kind !== "lro") return;
+  const respType = method.response.type;
+  if (respType && isPagedResultModel(context, respType)) {
+    pagedModelsUsedInNonPagingOps.add(respType);
+  }
 }
 
 function visitType(context: SdkContext, type: SdkType | undefined) {

package/src/modular/helpers/namingHelpers.ts

@@ -7,6 +7,7 @@ import {
   SdkClientType,
   SdkServiceOperation
 } from "@azure-tools/typespec-client-generator-core";
+import { SdkContext } from "../../utils/interfaces.js";
 import { ServiceOperation } from "../../utils/operationUtil.js";
 
 export function getClientName(
@@ -26,9 +27,14 @@ export interface GuardedName {
   fixme?: string[];
 }
 
-export function getOperationName(operation: ServiceOperation): GuardedName {
+export function getOperationName(
+  operation: ServiceOperation,
+  dpgContext?: SdkContext
+): GuardedName {
   const norm = normalizeName(operation.name, NameType.Method, true);
-  if (isReservedName(operation.name, NameType.Method)) {
+  const isDataplane =
+    dpgContext !== undefined && !dpgContext.rlcOptions?.azureArm;
+  if (isReservedName(operation.name, NameType.Method) && isDataplane) {
     return {
       name: norm,
       fixme: [

package/src/modular/helpers/operationHelpers.ts

@@ -1100,7 +1100,7 @@ export function getOperationFunction(
     }
   }
 
-  const { name, fixme = [] } = getOperationName(operation);
+  const { name, fixme = [] } = getOperationName(operation, context);
   const functionStatement = {
     kind: StructureKind.Function,
     docs: [
@@ -1248,7 +1248,7 @@ function getLroOnlyOperationFunction(
   const parameters: OptionalKind<ParameterDeclarationStructure>[] =
     getOperationSignatureParameters(context, method, clientType);
   const returnType = buildLroReturnType(context, operation);
-  const { name, fixme = [] } = getOperationName(operation);
+  const { name, fixme = [] } = getOperationName(operation, context);
   const pollerLikeReference = resolveReference(
     AzurePollingDependencies.PollerLike
   );
@@ -1343,7 +1343,7 @@ function getLroAndPagingOperationFunction(
     method,
     clientType
   );
-  const { name, fixme = [] } = getOperationName(operation);
+  const { name, fixme = [] } = getOperationName(operation, context);
 
   const returnType = buildLroPagingReturnType(context, operation);
 
@@ -1476,7 +1476,7 @@ function getPagingOnlyOperationFunction(
       type: getTypeExpression(context, type.valueType)
     };
   }
-  const { name, fixme = [] } = getOperationName(operation);
+  const { name, fixme = [] } = getOperationName(operation, context);
   const pagedAsyncIterableIteratorReference = resolveReference(
     PagingHelpers.PagedAsyncIterableIterator
   );
@@ -2318,12 +2318,20 @@ export function getSerializationExpression(
       skipDiscriminatedUnionSuffix: false
     }
   );
+
+  // Apply clientDefaultValue for model properties that have one
+  const defaultValueSuffix =
+    property.clientDefaultValue !== undefined &&
+    isDefaultValueTypeMatch(property, property.clientDefaultValue)
+      ? ` ?? ${formatDefaultValue(property.clientDefaultValue)}`
+      : "";
+
   if (serializeFunctionName) {
-    return `${nullOrUndefinedPrefix}${serializeFunctionName}(${propertyFullName})`;
+    return `${nullOrUndefinedPrefix}${serializeFunctionName}(${propertyFullName})${defaultValueSuffix}`;
   } else if (isAzureCoreErrorType(context.program, property.type.__raw)) {
-    return `${nullOrUndefinedPrefix}${propertyFullName}`;
+    return `${nullOrUndefinedPrefix}${propertyFullName}${defaultValueSuffix}`;
   } else {
-    return serializeRequestValue(
+    const baseExpr = serializeRequestValue(
       context,
       property.type,
       propertyFullName,
@@ -2332,6 +2340,7 @@ export function getSerializationExpression(
       getPropertySerializedName(property),
       propertyPath === "" ? true : false
     );
+    return `${baseExpr}${defaultValueSuffix}`;
   }
 }
 
@@ -2880,11 +2889,11 @@ export function getAllAncestors(type: SdkType): SdkType[] {
 }
 
 /**
- * Checks if a clientDefaultValue type matches the parameter type.
- * Returns true if the default value type is compatible with the parameter type.
+ * Checks if a clientDefaultValue type matches a parameter or model property type.
+ * Returns true if the default value type is compatible with the target type.
  */
 function isDefaultValueTypeMatch(
-  param: SdkHttpParameter | SdkBodyParameter,
+  param: SdkHttpParameter | SdkBodyParameter | SdkModelPropertyType,
   defaultValue: unknown
 ): boolean {
   const defaultType = typeof defaultValue;