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

package/src/modular/emitSamples.ts

@@ -34,11 +34,13 @@ import {
 } from "../utils/credentialUtils.js";
 import {
   getMethodHierarchiesMap,
+  isTenantLevelOperation,
   ServiceOperation
 } from "../utils/operationUtil.js";
 import { getSubscriptionId } from "../transform/transfromRLCOptions.js";
 import { getClientParametersDeclaration } from "./helpers/clientHelpers.js";
 import { getOperationFunction } from "./helpers/operationHelpers.js";
+import { ModelOverrideOptions } from "./serialization/serializeUtils.js";
 
 /**
  * Interfaces for samples generations
@@ -272,6 +274,7 @@ function buildParameterValueMap(example: SdkHttpOperationExample) {
 }
 
 function prepareExampleValue(
+  context: SdkContext,
   name: string,
   value: SdkExampleValue | string,
   isOptional?: boolean,
@@ -279,7 +282,8 @@ function prepareExampleValue(
 ): ExampleValue {
   return {
     name: normalizeName(name, NameType.Parameter),
-    value: typeof value === "string" ? value : getParameterValue(value),
+    value:
+      typeof value === "string" ? value : getParameterValue(context, value),
     isOptional: Boolean(isOptional),
     onClient: Boolean(onClient)
   };
@@ -328,6 +332,7 @@ function prepareExampleParameters(
   }
 
   let subscriptionIdValue = `"00000000-0000-0000-0000-000000000000"`;
+  let isSubscriptionIdAdded = false;
   // required parameters
   for (const param of method.operation.parameters) {
     if (
@@ -339,6 +344,26 @@ function prepareExampleParameters(
     }
 
     const exampleValue = parameterMap[param.serializedName];
+
+    // Handle subscriptionId parameter separately for ARM clients
+    // Add it as long as it's the parameter of the method, even no example provided
+    if (param.name.toLowerCase() === "subscriptionid" && dpgContext.arm) {
+      isSubscriptionIdAdded = true;
+      if (exampleValue && exampleValue.value) {
+        subscriptionIdValue = getParameterValue(dpgContext, exampleValue.value);
+      }
+      result.push(
+        prepareExampleValue(
+          dpgContext,
+          param.name,
+          subscriptionIdValue,
+          param.optional,
+          param.onClient
+        )
+      );
+      continue;
+    }
+
     if (!exampleValue || !exampleValue.value) {
       // report diagnostic if required parameter is missing
       reportDiagnostic(dpgContext.program, {
@@ -352,16 +377,9 @@ function prepareExampleParameters(
       continue;
     }
 
-    if (
-      param.name.toLowerCase() === "subscriptionid" &&
-      dpgContext.arm &&
-      exampleValue
-    ) {
-      subscriptionIdValue = getParameterValue(exampleValue.value);
-      continue;
-    }
     result.push(
       prepareExampleValue(
+        dpgContext,
         exampleValue.parameter.name,
         exampleValue.value,
         param.optional,
@@ -369,12 +387,26 @@ function prepareExampleParameters(
       )
     );
   }
-  // add subscriptionId for ARM clients if ARM clients need it
-  if (dpgContext.arm && getSubscriptionId(dpgContext)) {
+
+  // If client-level subscriptionId is needed on the client for this method, then add it
+  // For example, Operations_List
+  if (
+    dpgContext.arm &&
+    getSubscriptionId(dpgContext) &&
+    !isSubscriptionIdAdded &&
+    !isTenantLevelOperation(method, topLevelClient)
+  ) {
     result.push(
-      prepareExampleValue("subscriptionId", subscriptionIdValue, false, true)
+      prepareExampleValue(
+        dpgContext,
+        "subscriptionId",
+        subscriptionIdValue,
+        false,
+        true
+      )
     );
   }
+
   // required/optional body parameters
   const bodyParam = method.operation.bodyParam;
   const bodySerializeName = bodyParam?.serializedName;
@@ -392,6 +424,7 @@ function prepareExampleParameters(
         }
         result.push(
           prepareExampleValue(
+            dpgContext,
             prop.name,
             propExample,
             prop.optional,
@@ -402,6 +435,7 @@ function prepareExampleParameters(
     } else {
       result.push(
         prepareExampleValue(
+          dpgContext,
           bodyParam.name,
           bodyExample.value,
           bodyParam.optional,
@@ -422,6 +456,7 @@ function prepareExampleParameters(
     .forEach((param) => {
       result.push(
         prepareExampleValue(
+          dpgContext,
           param.parameter.name,
           param.value,
           true,
@@ -471,7 +506,13 @@ function getCredentialExampleValue(
   return undefined;
 }
 
-function getParameterValue(value: SdkExampleValue): string {
+function getParameterValue(
+  context: SdkContext,
+  value: SdkExampleValue,
+  options?: {
+    overrides?: ModelOverrideOptions;
+  }
+): string {
   let retValue = `{} as any`;
   switch (value.kind) {
     case "string": {
@@ -509,21 +550,43 @@ function getParameterValue(value: SdkExampleValue): string {
       break;
     case "dict":
     case "model": {
-      const mapper = buildPropertyNameMapper(value.type);
+      const mapper = buildPropertyNameMapper(
+        context,
+        value.type,
+        options?.overrides
+      );
       const values = [];
       const additionalPropertiesValue =
         value.kind === "model" ? (value.additionalPropertiesValue ?? {}) : {};
       for (const propName in {
         ...value.value
       }) {
+        let property;
+        if (value.type.kind === "model") {
+          property = value.type.properties.find((p) => p.name === propName);
+        }
         const propValue = value.value[propName];
         if (propValue === undefined || propValue === null) {
           continue;
         }
-        const propRetValue =
-          `"${mapper.get(propName) ?? propName}": ` +
-          getParameterValue(propValue);
-        values.push(propRetValue);
+        let propRetValue;
+
+        if (property?.flatten && property.type.kind === "model") {
+          const paramValue = getParameterValue(context, propValue, {
+            overrides: {
+              propertyRenames:
+                useContext("sdkTypes").flattenProperties.get(property)
+                  ?.conflictMap
+            }
+          });
+          propRetValue =
+            paramValue.length > 2 ? paramValue.slice(1, -1) : undefined;
+        } else {
+          propRetValue =
+            `"${mapper.get(propName) ?? propName}": ` +
+            getParameterValue(context, propValue);
+        }
+        if (propRetValue) values.push(propRetValue);
       }
       const additionalBags = [];
       for (const propName in {
@@ -535,7 +598,7 @@ function getParameterValue(value: SdkExampleValue): string {
         }
         const propRetValue =
           `"${mapper.get(propName) ?? propName}": ` +
-          getParameterValue(propValue);
+          getParameterValue(context, propValue);
         additionalBags.push(propRetValue);
       }
       if (additionalBags.length > 0) {
@@ -551,7 +614,9 @@ function getParameterValue(value: SdkExampleValue): string {
       break;
     }
     case "array": {
-      const valuesArr = value.value.map(getParameterValue);
+      const valuesArr = value.value.map((item) =>
+        getParameterValue(context, item)
+      );
       retValue = `[${valuesArr.join(", ")}]`;
       break;
     }

package/src/modular/helpers/operationHelpers.ts

@@ -24,8 +24,10 @@ import {
   ServiceOperation
 } from "../../utils/operationUtil.js";
 import {
+  getPropertyWithOverrides,
   isNormalUnion,
-  isSpecialHandledUnion
+  isSpecialHandledUnion,
+  ModelOverrideOptions
 } from "../serialization/serializeUtils.js";
 import {
   getDocsFromDescription,
@@ -33,8 +35,14 @@ import {
 } from "./docsHelpers.js";
 import { AzurePollingDependencies } from "../external-dependencies.js";
 import { NameType, normalizeName } from "@azure-tools/rlc-common";
-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 { refkey } from "../../framework/refkey.js";
 import { reportDiagnostic } from "../../lib.js";
 import { resolveReference } from "../../framework/reference.js";
@@ -64,6 +72,7 @@ import {
   SdkType
 } from "@azure-tools/typespec-client-generator-core";
 import { isMetadata } from "@typespec/http";
+import { useContext } from "../../contextManager.js";
 
 export function getSendPrivateFunction(
   dpgContext: SdkContext,
@@ -221,8 +230,10 @@ export function getDeserializePrivateFunction(
     const deserializeFunctionName = buildModelDeserializer(
       context,
       deserializedType,
-      false,
-      true
+      {
+        nameOnly: true,
+        skipDiscriminatedUnionSuffix: false
+      }
     );
     if (deserializeFunctionName) {
       statements.push(`return ${deserializeFunctionName}(${deserializedRoot})`);
@@ -277,8 +288,10 @@ function getExceptionDetails(
     const deserializeFunctionName = buildModelDeserializer(
       context,
       exception.type,
-      false,
-      true
+      {
+        nameOnly: true,
+        skipDiscriminatedUnionSuffix: false
+      }
     );
     if (
       !deserializeFunctionName ||
@@ -809,8 +822,10 @@ function buildBodyParameter(
   const serializerFunctionName = buildModelSerializer(
     context,
     getNullableValidType(bodyParameter.type),
-    false,
-    true
+    {
+      nameOnly: true,
+      skipDiscriminatedUnionSuffix: false
+    }
   );
 
   const bodyParamName = normalizeName(
@@ -1153,11 +1168,48 @@ function getNullableCheck(name: string, type: SdkType) {
   return `${name} === null ? null :`;
 }
 
-export function getSerializationExpression(
+function getSerializationExpressionForFlatten(
   context: SdkContext,
   property: SdkModelPropertyType,
   propertyPath: string
 ): string {
+  const serializeFunctionName = buildPropertySerializer(context, property, {
+    nameOnly: true,
+    skipDiscriminatedUnionSuffix: false
+  });
+  if (!serializeFunctionName) {
+    return property.optional ? `undefined` : `{}`;
+  }
+  const validProps = getAllProperties(
+    context,
+    property.type,
+    getAllAncestors(property.type)
+  ).filter(
+    (p) =>
+      p.kind === "property" &&
+      !isReadOnly(p) &&
+      !isMetadata(context.program, p.__raw!)
+  );
+  if (validProps.length === 0) {
+    return `undefined`;
+  }
+  const optionalPrefix = property.optional
+    ? `${resolveReference(SerializationHelpers.areAllPropsUndefined)}(${propertyPath}, [${validProps
+        .map((p) => `"${p.name}"`)
+        .join(", ")}]) ? undefined : `
+    : "";
+  return `${optionalPrefix}${serializeFunctionName}(${propertyPath})`;
+}
+
+export function getSerializationExpression(
+  context: SdkContext,
+  property: SdkModelPropertyType,
+  propertyPath: string,
+  enableFlatten: boolean = true
+): string {
+  if (property.flatten && enableFlatten) {
+    return getSerializationExpressionForFlatten(context, property, "item");
+  }
   const dot = propertyPath.endsWith("?") ? "." : "";
   const propertyPathWithDot = `${propertyPath ? `${propertyPath}${dot}` : `${dot}`}`;
   const nullOrUndefinedPrefix = getPropertySerializationPrefix(
@@ -1174,8 +1226,10 @@ export function getSerializationExpression(
   const serializeFunctionName = buildModelSerializer(
     context,
     getNullableValidType(property.type),
-    false,
-    true
+    {
+      nameOnly: true,
+      skipDiscriminatedUnionSuffix: false
+    }
   );
   if (serializeFunctionName) {
     return `${nullOrUndefinedPrefix}${serializeFunctionName}(${propertyFullName})`;
@@ -1196,7 +1250,9 @@ export function getSerializationExpression(
 export function getRequestModelProperties(
   context: SdkContext,
   modelPropertyType: SdkModelType & { optional?: boolean },
-  propertyPath: string = "body"
+  propertyPath: string = "body",
+  overrides?: ModelOverrideOptions,
+  enableFlatten: boolean = true
 ): Array<[string, string]> {
   const props: [string, string][] = [];
   const allParents = getAllAncestors(modelPropertyType);
@@ -1205,16 +1261,17 @@ export function getRequestModelProperties(
   if (properties.length <= 0) {
     return [];
   }
-  for (const property of properties) {
-    if (property.kind === "property" && isReadOnly(property)) {
+  for (const prop of properties) {
+    if (prop.kind === "property" && isReadOnly(prop)) {
       continue;
     }
-    if (isMetadata(context.program, property.__raw!)) {
+    if (isMetadata(context.program, prop.__raw!)) {
       continue;
     }
+    const property = getPropertyWithOverrides(prop, overrides);
     props.push([
       getPropertySerializedName(property)!,
-      getSerializationExpression(context, property, propertyPath)
+      getSerializationExpression(context, property, propertyPath, enableFlatten)
     ]);
   }
 
@@ -1229,12 +1286,16 @@ export function getRequestModelProperties(
 export function getRequestModelMapping(
   context: SdkContext,
   modelPropertyType: SdkModelType & { optional?: boolean },
-  propertyPath: string = "body"
+  propertyPath: string = "body",
+  overrides?: ModelOverrideOptions,
+  enableFlatten: boolean = true
 ): string[] {
   return getRequestModelProperties(
     context,
     modelPropertyType,
-    propertyPath
+    propertyPath,
+    overrides,
+    enableFlatten
   ).map(([name, value]) => `"${name}": ${value}`);
 }
 
@@ -1255,16 +1316,19 @@ function getPropertySerializedName(
 export function getResponseMapping(
   context: SdkContext,
   type: SdkType,
-  propertyPath: string = "result.body"
+  propertyPath: string = "result.body",
+  overrides?: ModelOverrideOptions,
+  enableFlatten: boolean = true
 ) {
   const allParents = type.kind === "model" ? getAllAncestors(type) : [];
   const properties =
     type.kind === "model" ? getAllProperties(context, type, allParents) : [];
   const props: string[] = [];
-  for (const property of properties) {
-    if (isMetadata(context.program, property.__raw!)) {
+  for (const prop of properties) {
+    if (isMetadata(context.program, prop.__raw!)) {
       continue;
     }
+    const property = getPropertyWithOverrides(prop, overrides);
     const dot = propertyPath.endsWith("?") ? "." : "";
     const serializedName = getPropertySerializedName(property);
     const restValue = `${
@@ -1275,17 +1339,29 @@ export function getResponseMapping(
       property.optional || isTypeNullable(property.type)
         ? `!${restValue}? ${restValue}: `
         : "";
-    const deserializeFunctionName = buildModelDeserializer(
-      context,
-      getNullableValidType(property.type),
-      false,
-      true
-    );
+    const flattenContext =
+      useContext("sdkTypes").flattenProperties.get(property);
+    const isSupportedFlatten = flattenContext && enableFlatten;
+    const deserializeFunctionName = isSupportedFlatten
+      ? buildPropertyDeserializer(context, property, {
+          nameOnly: true,
+          skipDiscriminatedUnionSuffix: false
+        })
+      : buildModelDeserializer(context, getNullableValidType(property.type), {
+          nameOnly: true,
+          skipDiscriminatedUnionSuffix: false
+        });
     const propertyName = normalizeModelPropertyName(context, property);
     if (deserializeFunctionName) {
-      props.push(
-        `${propertyName}: ${nullOrUndefinedPrefix}${deserializeFunctionName}(${restValue})`
-      );
+      if (isSupportedFlatten) {
+        props.push(
+          `...${nullOrUndefinedPrefix}${deserializeFunctionName}(${restValue})`
+        );
+      } else {
+        props.push(
+          `${propertyName}: ${nullOrUndefinedPrefix}${deserializeFunctionName}(${restValue})`
+        );
+      }
     } else if (isAzureCoreErrorType(context.program, property.type.__raw)) {
       props.push(`${propertyName}: ${nullOrUndefinedPrefix}${restValue}`);
     } else {
@@ -1343,8 +1419,10 @@ export function serializeRequestValue(
         const serializeFunctionName = buildModelSerializer(
           context,
           getNullableValidType(type.valueType),
-          false,
-          true
+          {
+            nameOnly: true,
+            skipDiscriminatedUnionSuffix: false
+          }
         );
         if (serializeFunctionName) {
           return `${prefix}.map((p: any) => { return ${elementNullOrUndefinedPrefix}${serializeFunctionName}(p)})`;
@@ -1451,8 +1529,10 @@ export function deserializeResponseValue(
         ? buildModelDeserializer(
             context,
             getNullableValidType(type.valueType),
-            false,
-            true
+            {
+              nameOnly: true,
+              skipDiscriminatedUnionSuffix: false
+            }
           )
         : undefined;
       if (deserializeFunctionName) {
@@ -1468,6 +1548,38 @@ export function deserializeResponseValue(
         return restValue;
       }
     }
+    case "dict": {
+      const prefix = nullOrUndefinedPrefix + restValue;
+      let elementNullOrUndefinedPrefix = "";
+      if (
+        type.valueType &&
+        (isTypeNullable(type.valueType) || getOptionalForType(type.valueType))
+      ) {
+        elementNullOrUndefinedPrefix = "!p ? p :";
+      }
+      const deserializeFunctionName = type.valueType
+        ? buildModelDeserializer(
+            context,
+            getNullableValidType(type.valueType),
+            {
+              nameOnly: true,
+              skipDiscriminatedUnionSuffix: false
+            }
+          )
+        : undefined;
+      if (deserializeFunctionName) {
+        return `Object.fromEntries(Object.entries(${prefix}).map(([k, p]: [string, any]) => [k, ${elementNullOrUndefinedPrefix}${deserializeFunctionName}(p)]))`;
+      } else if (
+        type.valueType &&
+        isAzureCoreErrorType(context.program, type.valueType.__raw)
+      ) {
+        return `Object.fromEntries(Object.entries(${prefix}).map(([k, p]: [string, any]) => [k, ${elementNullOrUndefinedPrefix}p]))`;
+      } else if (type.valueType) {
+        return `Object.fromEntries(Object.entries(${prefix}).map(([k, p]: [string, any]) => [k, ${elementNullOrUndefinedPrefix}${deserializeResponseValue(context, type.valueType, "p", getEncodeForType(type.valueType))}]))`;
+      } else {
+        return restValue;
+      }
+    }
     case "bytes":
       if (format !== "binary" && format !== "bytes") {
         return `typeof ${restValue} === 'string'
@@ -1480,12 +1592,10 @@ export function deserializeResponseValue(
         return `${restValue}`;
       } else if (isSpecialHandledUnion(type)) {
         const deserializeFunctionName = type
-          ? buildModelDeserializer(
-              context,
-              getNullableValidType(type),
-              false,
-              true
-            )
+          ? buildModelDeserializer(context, getNullableValidType(type), {
+              nameOnly: true,
+              skipDiscriminatedUnionSuffix: false
+            })
           : undefined;
         if (deserializeFunctionName) {
           return `${deserializeFunctionName}(${restValue})`;

package/src/modular/helpers/typeHelpers.ts

@@ -7,6 +7,12 @@ import {
   SdkModelType,
   SdkType
 } from "@azure-tools/typespec-client-generator-core";
+import {
+  getPropertyWithOverrides,
+  ModelOverrideOptions
+} from "../serialization/serializeUtils.js";
+import { getAllAncestors, getAllProperties } from "./operationHelpers.js";
+import { SdkContext } from "../../utils/interfaces.js";
 
 export function getDirectSubtypes(type: SdkModelType) {
   if (!type.discriminatedSubtypes) {
@@ -93,15 +99,25 @@ export function isCredentialType(
  * Builds a property name mapper between the serializedName and the name of the property.
  * Return empty map if the type is not a model.
  */
-export function buildPropertyNameMapper(model: SdkType) {
+export function buildPropertyNameMapper(
+  context: SdkContext,
+  model: SdkType,
+  overrides?: ModelOverrideOptions
+) {
   const mapper = new Map<string, string>();
   if (model.kind !== "model") {
     return mapper;
   }
-  for (const prop of model.properties) {
-    if (prop.kind !== "property") {
+  const allProperties = getAllProperties(
+    context,
+    model,
+    getAllAncestors(model)
+  );
+  for (const p of allProperties) {
+    if (p.kind !== "property") {
       continue;
     }
+    const prop = getPropertyWithOverrides(p, overrides);
     mapper.set(
       prop.serializationOptions.json?.name || prop.name,
       normalizeName(prop.name, NameType.Property)