@azure-tools/typespec-ts 0.46.1-alpha.20251201.1 → 0.47.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.46.1-alpha.20251201.1",
+  "version": "0.47.0",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -18,14 +18,14 @@
   "license": "MIT",
   "devDependencies": {
     "@azure-rest/core-client": "^2.3.1",
-    "@typespec/http-specs": "0.1.0-alpha.29-dev.2",
-    "@typespec/spector": "0.1.0-alpha.21-dev.1",
-    "@typespec/spec-api": "0.1.0-alpha.11-dev.0",
+    "@typespec/http-specs": "0.1.0-alpha.29-dev.5",
+    "@typespec/spector": "0.1.0-alpha.21-dev.3",
+    "@typespec/spec-api": "0.1.0-alpha.11-dev.1",
     "@typespec/tspd": "0.73.1",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.33-dev.0",
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.33-dev.4",
     "@azure-tools/typespec-autorest": "^0.62.0",
     "@azure-tools/typespec-azure-core": "^0.62.0",
-    "@azure-tools/typespec-azure-resource-manager": "^0.62.0",
+    "@azure-tools/typespec-azure-resource-manager": "^0.62.1",
     "@azure-tools/typespec-client-generator-core": "^0.62.0",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
@@ -38,7 +38,6 @@
     "@types/fs-extra": "^9.0.13",
     "@types/lodash": "^4.17.4",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^18.0.0",
     "@typescript-eslint/eslint-plugin": "^8.28.0",
     "@typescript-eslint/parser": "^8.28.0",
     "@typespec/compiler": "^1.6.0",
@@ -51,14 +50,11 @@
     "chalk": "^4.0.0",
     "cross-env": "^7.0.3",
     "eslint-plugin-require-extensions": "0.1.3",
-    "eslint": "^8.9.0",
     "mkdirp": "^3.0.1",
     "mocha": "^10.4.0",
     "npm-run-all": "~4.1.5",
     "prettier": "^3.3.3",
-    "rimraf": "^5.0.0",
     "ts-node": "~10.9.1",
-    "typescript": "~5.8.2",
     "vitest": "~1.6.0",
     "@vitest/coverage-v8": "~1.6.0",
     "@vitest/coverage-istanbul": "~1.6.0",
@@ -77,7 +73,7 @@
     "@typespec/xml": "^0.76.0"
   },
   "dependencies": {
-    "@azure-tools/rlc-common": "0.46.1-alpha.20251201.1",
+    "@azure-tools/rlc-common": "^0.47.0",
     "fs-extra": "^11.1.0",
     "lodash": "^4.17.21",
     "prettier": "^3.3.3",

package/src/framework/hooks/sdkTypes.ts

@@ -2,6 +2,8 @@ import { Operation, Type, getNamespaceFullName } from "@typespec/compiler";
 import {
   SdkClientType,
   SdkHttpOperation,
+  SdkModelPropertyType,
+  SdkModelType,
   SdkServiceMethod,
   SdkType,
   getClientType
@@ -10,12 +12,27 @@ import { provideContext, useContext } from "../../contextManager.js";
 
 import { visitPackageTypes } from "../../modular/emitModels.js";
 import { SdkContext } from "../../utils/interfaces.js";
+import {
+  getAllAncestors,
+  getAllProperties
+} from "../../modular/helpers/operationHelpers.js";
+import { normalizeModelPropertyName } from "../../modular/type-expressions/get-type-expression.js";
+import { reportDiagnostic } from "../../lib.js";
+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>();
 
 export interface SdkTypeContext {
   operations: Map<Type, SdkServiceMethod<SdkHttpOperation>>;
   types: Map<Type, SdkType>;
+  flattenProperties: Map<SdkModelPropertyType, SdkFlattenPropertyContext>;
+}
+
+export interface SdkFlattenPropertyContext {
+  baseModel: SdkModelType;
+  conflictMap?: Map<SdkModelPropertyType, string>;
 }
 
 export function useSdkTypes() {
@@ -56,11 +73,20 @@ export function useSdkTypes() {
 
 export function provideSdkTypes(context: SdkContext) {
   const { sdkPackage } = context;
-  const sdkTypesContext = {
+  const sdkTypesContext: SdkTypeContext = {
     operations: new Map<Type, SdkServiceMethod<SdkHttpOperation>>(),
-    types: new Map<Type, SdkType>()
+    types: new Map<Type, SdkType>(),
+    flattenProperties: new Map<
+      SdkModelPropertyType,
+      SdkFlattenPropertyContext
+    >()
   };
   visitPackageTypes(context);
+  enrichFlattenProperties(
+    context,
+    sdkTypesContext.flattenProperties,
+    flattenPropertyModelMap
+  );
   for (const sdkModel of emitQueue) {
     switch (sdkModel.kind) {
       case "model":
@@ -126,6 +152,80 @@ export function provideSdkTypes(context: SdkContext) {
   provideContext("sdkTypes", sdkTypesContext);
 }
 
+// Enrich flatten properties with their base models and conflict maps
+function enrichFlattenProperties(
+  context: SdkContext,
+  propertyContextMap: Map<SdkModelPropertyType, SdkFlattenPropertyContext>,
+  propertyModelMap: Map<SdkModelPropertyType, SdkModelType>
+) {
+  // Build a map of base model to its existing properties excluding flatten properties
+  // To check for conflicts later
+  const baseModelProperties = new Map<SdkModelType, Set<string>>();
+  propertyModelMap.forEach((baseModel, _) => {
+    if (!baseModelProperties.has(baseModel)) {
+      const propertiesExcludedFlatten = getAllProperties(
+        context,
+        baseModel,
+        getAllAncestors(baseModel)
+      )
+        .filter((p) => p.flatten === false || p.flatten === undefined)
+        .map((p) => normalizeModelPropertyName(context, p));
+      baseModelProperties.set(
+        baseModel,
+        new Set<string>(propertiesExcludedFlatten)
+      );
+    }
+  });
+  for (const [flattenProperty, baseModel] of propertyModelMap) {
+    const flattenContext: SdkFlattenPropertyContext = {
+      baseModel: baseModel
+    };
+    propertyContextMap.set(flattenProperty, flattenContext);
+    const existingProperties = baseModelProperties.get(baseModel)!;
+    const conflictMap = new Map<SdkModelPropertyType, string>();
+    const flattenModel = flattenProperty.type;
+
+    if (flattenModel.kind !== "model") {
+      continue;
+    }
+    if (baseModelProperties.has(flattenModel)) {
+      // If the flatten model is also a base model of other flatten properties, which means it has multiple consecutive flatten operations
+      // Since we cannot handle the flatten transition, report warning and skip it for now
+      reportDiagnostic(context.program, {
+        code: "unsupported-flatten-transition",
+        format: {
+          propertyName: flattenProperty.name,
+          modelName: baseModel.name
+        },
+        target: flattenProperty.__raw!
+      });
+    }
+    const allFlattenProperties = getAllProperties(
+      context,
+      flattenModel,
+      getAllAncestors(flattenModel)
+    );
+    for (const flattenChildProperty of allFlattenProperties) {
+      let childPropertyName = normalizeModelPropertyName(
+        context,
+        flattenChildProperty
+      );
+      if (existingProperties.has(childPropertyName)) {
+        childPropertyName = normalizeName(
+          `${childPropertyName}_${flattenProperty.name}_${childPropertyName}`,
+          NameType.Property
+        );
+        conflictMap.set(flattenChildProperty, childPropertyName);
+      }
+      existingProperties.add(childPropertyName);
+    }
+    if (conflictMap.size === 0) {
+      continue;
+    }
+    flattenContext.conflictMap = conflictMap;
+  }
+}
+
 export function getAllOperationsFromClient(
   client: SdkClientType<SdkHttpOperation>
 ) {

package/src/lib.ts

@@ -549,6 +549,12 @@ const libDef = {
         default: paramMessage`The parameter name ${"parameterName"} has conflicts with others and please use @clientName to rename it.`
       }
     },
+    "unsupported-flatten-transition": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`The property "${"propertyName"}" in "${"modelName"}" has multiple consecutive flatten operations. Flatten transitions are not supported so consecutive transitions will be ignored.`
+      }
+    },
     "unsupported-parameter-type": {
       severity: "error",
       messages: {
@@ -596,6 +602,12 @@ const libDef = {
       messages: {
         default: paramMessage`Error traversing directory ${"directory"}: ${"error"}`
       }
+    },
+    "detected-model-name-conflict": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`Model name conflict detected: "${"modelName"}" exists in multiple namespaces: ${"namespaces"}. Please use @clientName to rename them.`
+      }
     }
   },
   emitter: {

package/src/modular/buildClassicalClient.ts

@@ -31,7 +31,10 @@ import {
   SdkServiceMethod,
   SdkServiceOperation
 } from "@azure-tools/typespec-client-generator-core";
-import { getMethodHierarchiesMap } from "../utils/operationUtil.js";
+import {
+  getMethodHierarchiesMap,
+  isTenantLevelOperation
+} from "../utils/operationUtil.js";
 import { useContext } from "../contextManager.js";
 import { refkey } from "../framework/refkey.js";
 import { SimplePollerHelpers } from "./static-helpers-metadata.js";
@@ -119,11 +122,28 @@ export function buildClassicalClient(
     });
   }
 
-  // TODO: We may need to generate constructor overloads at some point. Here we'd do that.
-  const constructor = clientClass.addConstructor({
-    docs: getDocsFromDescription(client.doc),
-    parameters: classicalParams
-  });
+  // Check if constructor overloads for subscriptionId is needed
+  const hasSubscriptionIdParam = classicalParams.some(
+    (param) => param.name.toLowerCase() === "subscriptionid"
+  );
+  const shouldSubscriptionIdOptional =
+    dpgContext.arm &&
+    hasSubscriptionIdParam &&
+    hasTenantLevelOperations(client, dpgContext);
+
+  let constructor;
+  if (shouldSubscriptionIdOptional) {
+    constructor = generateConstructorWithOverloads(
+      clientClass,
+      classicalParams,
+      client
+    );
+  } else {
+    constructor = clientClass.addConstructor({
+      docs: getDocsFromDescription(client.doc),
+      parameters: classicalParams
+    });
+  }
 
   const paramNames = (contextParams ?? [])
     .map((p) => p.name)
@@ -134,6 +154,11 @@ export function buildClassicalClient(
           emitterOptions,
           "azsdk-js-client"
         )}}`;
+      } else if (
+        x.toLowerCase() === "subscriptionid" &&
+        shouldSubscriptionIdOptional
+      ) {
+        return `subscriptionId ?? ""`;
       } else {
         return x;
       }
@@ -370,3 +395,88 @@ function addChildClient(
     )`
   );
 }
+
+function hasTenantLevelOperations(
+  client: SdkClientType<SdkServiceOperation>,
+  dpgContext: SdkContext
+): boolean {
+  const methodMap = getMethodHierarchiesMap(dpgContext, client);
+
+  for (const [_, operations] of methodMap) {
+    for (const op of operations) {
+      if (isTenantLevelOperation(op, client)) {
+        // Found a tenant-level operation
+        return true;
+      }
+    }
+  }
+
+  return false;
+}
+
+function generateConstructorWithOverloads(
+  clientClass: ClassDeclaration,
+  classicalParams: any[],
+  client: SdkClientType<SdkServiceOperation>
+) {
+  const filteredParams = classicalParams.filter(
+    (p) =>
+      p.name.toLowerCase() !== "subscriptionid" &&
+      p.name.toLowerCase() !== "options"
+  );
+
+  const clientConstructor = clientClass.addConstructor({
+    docs: getDocsFromDescription(client.doc),
+    parameters: [
+      ...filteredParams,
+      {
+        name: "subscriptionIdOrOptions",
+        type: `string | ${getClassicalClientName(client)}OptionalParams`,
+        hasQuestionToken: true
+      },
+      {
+        name: "options",
+        type: `${getClassicalClientName(client)}OptionalParams`,
+        hasQuestionToken: true
+      }
+    ]
+  });
+
+  clientConstructor.addOverload({
+    parameters: [
+      ...filteredParams,
+      {
+        name: "options",
+        type: `${getClassicalClientName(client)}OptionalParams`,
+        hasQuestionToken: true
+      }
+    ]
+  });
+
+  clientConstructor.addOverload({
+    parameters: [
+      ...filteredParams,
+      ...classicalParams.filter(
+        (p) => p.name.toLowerCase() === "subscriptionid"
+      ),
+      {
+        name: "options",
+        type: `${getClassicalClientName(client)}OptionalParams`,
+        hasQuestionToken: true
+      }
+    ]
+  });
+
+  clientConstructor.addStatements([
+    `let subscriptionId: string | undefined;`,
+    ``,
+    `if (typeof subscriptionIdOrOptions === "string") {`,
+    `  subscriptionId = subscriptionIdOrOptions;`,
+    `} else if (typeof subscriptionIdOrOptions === "object") {`,
+    `  options = subscriptionIdOrOptions;`,
+    `}`,
+    `options = options ?? {};`
+  ]);
+
+  return clientConstructor;
+}

package/src/modular/emitModels.ts

@@ -40,8 +40,14 @@ import {
 
 import { SdkContext } from "../utils/interfaces.js";
 import { addDeclaration } from "../framework/declaration.js";
-import { buildModelDeserializer } from "./serialization/buildDeserializerFunction.js";
-import { buildModelSerializer } from "./serialization/buildSerializerFunction.js";
+import {
+  buildModelDeserializer,
+  buildPropertyDeserializer
+} from "./serialization/buildDeserializerFunction.js";
+import {
+  buildModelSerializer,
+  buildPropertySerializer
+} from "./serialization/buildSerializerFunction.js";
 import path from "path";
 import { refkey } from "../framework/refkey.js";
 import { useContext } from "../contextManager.js";
@@ -50,6 +56,7 @@ import { isAzureCoreErrorType } from "../utils/modelUtils.js";
 import { isExtensibleEnum } from "./type-expressions/get-enum-expression.js";
 import {
   getAllDiscriminatedValues,
+  getPropertyWithOverrides,
   isDiscriminatedUnion
 } from "./serialization/serializeUtils.js";
 import { reportDiagnostic } from "../lib.js";
@@ -60,6 +67,7 @@ import {
 } from "./type-expressions/get-type-expression.js";
 import {
   emitQueue,
+  flattenPropertyModelMap,
   getAllOperationsFromClient
 } from "../framework/hooks/sdkTypes.js";
 import { resolveReference } from "../framework/reference.js";
@@ -122,6 +130,14 @@ export function emitTypes(
     emitType(context, type, sourceFile);
   }
 
+  // Emit serialization/deserialization functions for flattened properties
+  for (const [property, _] of flattenPropertyModelMap) {
+    const namespaces = getModelNamespaces(context, property.type);
+    const filepath = getModelsPath(sourceRoot, namespaces);
+    sourceFile = outputProject.getSourceFile(filepath);
+    addSerializationFunctions(context, property, sourceFile!);
+  }
+
   const modelFiles = outputProject.getSourceFiles(
     sourceRoot + "/models/**/*.ts"
   );
@@ -310,36 +326,38 @@ export function getModelNamespaces(
 
 function addSerializationFunctions(
   context: SdkContext,
-  type: SdkType,
+  typeOrProperty: SdkType | SdkModelPropertyType,
   sourceFile: SourceFile,
-  skipDiscriminatedUnion = false
+  skipDiscriminatedUnionSuffix = false
 ) {
-  const serializationFunction = buildModelSerializer(
-    context,
-    type,
-    skipDiscriminatedUnion
-  );
+  const options = {
+    nameOnly: false,
+    skipDiscriminatedUnionSuffix
+  };
+  const serializationFunction =
+    typeOrProperty.kind === "property"
+      ? buildPropertySerializer(context, typeOrProperty, options)
+      : buildModelSerializer(context, typeOrProperty, options);
 
-  const serializerRefkey = refkey(type, "serializer");
-  const deserailizerRefKey = refkey(type, "deserializer");
+  const serializerRefKey = refkey(typeOrProperty, "serializer");
+  const deserializerRefKey = refkey(typeOrProperty, "deserializer");
   if (
     serializationFunction &&
     typeof serializationFunction !== "string" &&
     serializationFunction.name
   ) {
-    addDeclaration(sourceFile, serializationFunction, serializerRefkey);
+    addDeclaration(sourceFile, serializationFunction, serializerRefKey);
   }
-  const deserializationFunction = buildModelDeserializer(
-    context,
-    type,
-    skipDiscriminatedUnion
-  );
+  const deserializationFunction =
+    typeOrProperty.kind === "property"
+      ? buildPropertyDeserializer(context, typeOrProperty, options)
+      : buildModelDeserializer(context, typeOrProperty, options);
   if (
     deserializationFunction &&
     typeof deserializationFunction !== "string" &&
     deserializationFunction.name
   ) {
-    addDeclaration(sourceFile, deserializationFunction, deserailizerRefKey);
+    addDeclaration(sourceFile, deserializationFunction, deserializerRefKey);
   }
 }
 
@@ -474,16 +492,47 @@ function buildModelInterface(
   context: SdkContext,
   type: SdkModelType
 ): InterfaceDeclarationStructure {
+  const flattenPropertySet = new Set<SdkModelPropertyType>();
   const interfaceStructure = {
     kind: StructureKind.Interface,
     name: normalizeModelName(context, type, NameType.Interface, true),
     isExported: true,
     properties: type.properties
       .filter((p) => !isMetadata(context.program, p.__raw!))
+      .filter((p) => {
+        // filter out the flatten property to be processed later
+        if (p.flatten) {
+          flattenPropertySet.add(p);
+          return false;
+        }
+        return true;
+      })
       .map((p) => {
         return buildModelProperty(context, p, type);
       })
   } as InterfaceStructure;
+  for (const flatten of flattenPropertySet.keys()) {
+    if (flatten.type?.kind !== "model" || !flatten.type.properties) {
+      continue;
+    }
+    const conflictMap =
+      useContext("sdkTypes").flattenProperties.get(flatten)?.conflictMap;
+    const allProperties = getAllProperties(
+      context,
+      flatten.type,
+      getAllAncestors(flatten.type)
+    ).filter((p) => !isMetadata(context.program, p.__raw!));
+    interfaceStructure.properties!.push(
+      ...allProperties.map((p) => {
+        // when the flattened property is optional, all its child properties should be optional too
+        const property = getPropertyWithOverrides(p, {
+          allOptional: flatten.optional,
+          propertyRenames: conflictMap
+        });
+        return buildModelProperty(context, property, type);
+      })
+    );
+  }
 
   if (type.baseModel) {
     const parentReference = getModelExpression(context, type.baseModel, {
@@ -635,7 +684,7 @@ function buildModelPolymorphicType(context: SdkContext, type: SdkModelType) {
   }
   const typeDeclaration: TypeAliasDeclarationStructure = {
     kind: StructureKind.TypeAlias,
-    name: `${normalizeName(type.name, NameType.Interface)}Union`,
+    name: `${normalizeModelName(context, type, NameType.Interface, true)}Union`,
     isExported: true,
     type: directSubtypes
       .filter((p) => {
@@ -747,6 +796,7 @@ function buildModelProperty(
 export function visitPackageTypes(context: SdkContext) {
   const { sdkPackage } = context;
   emitQueue.clear();
+  flattenPropertyModelMap.clear();
   // Add all models in the package to the emit queue
   for (const model of sdkPackage.models) {
     visitType(context, model);
@@ -852,6 +902,9 @@ function visitType(context: SdkContext, type: SdkType | undefined) {
       if (!emitQueue.has(property.type)) {
         visitType(context, property.type);
       }
+      if (property.flatten && property.type.kind === "model") {
+        flattenPropertyModelMap.set(property, type);
+      }
     }
     if (type.discriminatedSubtypes) {
       for (const subType of Object.values(type.discriminatedSubtypes)) {