@azure-tools/typespec-ts 0.46.1 → 0.47.0

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 ||
@@ -421,7 +434,11 @@ export function getOperationFunction(
   context: SdkContext,
   method: [string[], ServiceOperation],
   clientType: string
-): FunctionDeclarationStructure & { propertyName?: string } {
+): FunctionDeclarationStructure & {
+  propertyName?: string;
+  isLro?: boolean;
+  lroFinalReturnType?: string;
+} {
   const operation = method[1];
   // Extract required parameters
   const parameters: OptionalKind<ParameterDeclarationStructure>[] =
@@ -498,7 +515,11 @@ function getLroOnlyOperationFunction(
   method: [string[], SdkLroServiceMethod<SdkHttpOperation>],
   clientType: string,
   optionalParamName: string = "options"
-): FunctionDeclarationStructure & { propertyName?: string } {
+): FunctionDeclarationStructure & {
+  propertyName?: string;
+  isLro?: boolean;
+  lroFinalReturnType?: string;
+} {
   const operation = method[1];
   // Extract required parameters
   const parameters: OptionalKind<ParameterDeclarationStructure>[] =
@@ -521,6 +542,8 @@ function getLroOnlyOperationFunction(
     isExported: true,
     name,
     propertyName: normalizeName(operation.name, NameType.Property),
+    isLro: true,
+    lroFinalReturnType: returnType.type,
     parameters,
     returnType: `${pollerLikeReference}<${operationStateReference}<${returnType.type}>, ${returnType.type}>`
   };
@@ -799,8 +822,10 @@ function buildBodyParameter(
   const serializerFunctionName = buildModelSerializer(
     context,
     getNullableValidType(bodyParameter.type),
-    false,
-    true
+    {
+      nameOnly: true,
+      skipDiscriminatedUnionSuffix: false
+    }
   );
 
   const bodyParamName = normalizeName(
@@ -1143,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(
@@ -1164,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})`;
@@ -1186,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);
@@ -1195,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)
     ]);
   }
 
@@ -1219,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}`);
 }
 
@@ -1245,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 = `${
@@ -1265,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 {
@@ -1333,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)})`;
@@ -1441,8 +1529,10 @@ export function deserializeResponseValue(
         ? buildModelDeserializer(
             context,
             getNullableValidType(type.valueType),
-            false,
-            true
+            {
+              nameOnly: true,
+              skipDiscriminatedUnionSuffix: false
+            }
           )
         : undefined;
       if (deserializeFunctionName) {
@@ -1458,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'
@@ -1470,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)

package/src/modular/serialization/buildDeserializerFunction.ts

@@ -2,6 +2,7 @@ import { FunctionDeclarationStructure, StructureKind } from "ts-morph";
 import {
   SdkArrayType,
   SdkDictionaryType,
+  SdkModelPropertyType,
   SdkModelType,
   SdkType,
   SdkUnionType,
@@ -34,17 +35,55 @@ import {
 } from "../helpers/typeHelpers.js";
 import { reportDiagnostic } from "../../lib.js";
 import { NoTarget } from "@typespec/compiler";
+import { useContext } from "../../contextManager.js";
+
+export function buildPropertyDeserializer(
+  context: SdkContext,
+  property: SdkModelPropertyType,
+  options: ModelSerializeOptions = {
+    nameOnly: false,
+    skipDiscriminatedUnionSuffix: false
+  }
+) {
+  const propertyContext =
+    useContext("sdkTypes").flattenProperties.get(property);
+  // only build de-serializer for flatten property
+  if (property.flatten !== true || !propertyContext) {
+    return undefined;
+  }
+
+  const predefinedName = `_${normalizeName(
+    `${propertyContext.baseModel.name}_${property.name}`,
+    NameType.Method,
+    true
+  )}Deserializer`;
+  return buildModelDeserializer(context, property.type, {
+    ...options,
+    flatten: {
+      baseModel: propertyContext.baseModel,
+      property
+    },
+    overrides: {
+      allOptional: property.optional,
+      propertyRenames: propertyContext.conflictMap
+    },
+    predefinedName
+  });
+}
 
 export function buildModelDeserializer(
   context: SdkContext,
   type: SdkType,
-  skipDiscriminatedUnion = false,
-  nameOnly: boolean = false
+  options: ModelSerializeOptions = {
+    nameOnly: false,
+    skipDiscriminatedUnionSuffix: false
+  }
 ): FunctionDeclarationStructure | undefined | string {
   // const modelTcgcType = getTcgcType(type) as SdkModelType;
   if (!isSupportedSerializeType(type)) {
     return undefined;
   }
+  const { nameOnly, skipDiscriminatedUnionSuffix } = options;
   if (type.kind === "model" || type.kind === "union" || type.kind === "enum") {
     if (
       !type.usage ||
@@ -72,16 +111,13 @@ export function buildModelDeserializer(
     return buildPolymorphicDeserializer(context, type, nameOnly);
   }
 
-  if (isDiscriminatedUnion(type) && !skipDiscriminatedUnion) {
+  if (isDiscriminatedUnion(type) && !skipDiscriminatedUnionSuffix) {
     return buildDiscriminatedUnionDeserializer(context, type, nameOnly);
   }
 
   switch (type.kind) {
     case "model":
-      return buildModelTypeDeserializer(context, type, {
-        nameOnly,
-        skipDiscriminatedUnionSuffix: skipDiscriminatedUnion
-      });
+      return buildModelTypeDeserializer(context, type, options);
     case "union": // for non-discriminated union, we just return whatever we get
       return buildUnionDeserializer(context, type, nameOnly);
     case "dict":
@@ -220,6 +256,7 @@ function buildDiscriminatedUnionDeserializer(
   if (nameOnly) {
     return resolveReference(refkey(type, "deserializer"));
   }
+  // Get the base deserializer name and ensure reference tracking
   const baseDeserializerName = `${normalizeModelName(
     context,
     type,
@@ -241,12 +278,17 @@ function buildDiscriminatedUnionDeserializer(
       type.discriminatorProperty
     );
     const union = subType.discriminatedSubtypes ? "Union" : "";
-    const subTypeName = `${normalizeName(subType.name, NameType.Interface, true)}${union}`;
-    const subtypeDeserializerName = normalizeName(
-      `${subTypeName}Deserializer`,
-      NameType.Operation,
-      true
+    const subTypeName = normalizeModelName(
+      context,
+      subType,
+      NameType.Interface,
+      !union
     );
+    // Get the deserializer name and ensure reference tracking
+    const subtypeDeserializerName = buildModelDeserializer(context, subType, {
+      nameOnly: true,
+      skipDiscriminatedUnionSuffix: false
+    }) as string;
 
     const caseLabels = discriminatedValues.map((value) => `case "${value}":`);
     cases.push(`
@@ -338,14 +380,18 @@ function buildModelTypeDeserializer(
     });
     return ""; // Return empty string to continue processing
   }
-  const deserializerFunctionName = `${normalizeModelName(
-    context,
-    type,
-    NameType.Operation,
-    options.skipDiscriminatedUnionSuffix
-  )}Deserializer`;
+  const deserializerFunctionName =
+    options.predefinedName ??
+    `${normalizeModelName(
+      context,
+      type,
+      NameType.Operation,
+      options.skipDiscriminatedUnionSuffix
+    )}Deserializer`;
   if (options.nameOnly) {
-    return resolveReference(refkey(type, "deserializer"));
+    return options.flatten
+      ? resolveReference(refkey(options.flatten.property, "deserializer"))
+      : resolveReference(refkey(type, "deserializer"));
   }
   const deserializerFunction: FunctionDeclarationStructure = {
     kind: StructureKind.Function,
@@ -357,7 +403,9 @@ function buildModelTypeDeserializer(
         type: "any"
       }
     ],
-    returnType: resolveReference(refkey(type)),
+    returnType: options.flatten
+      ? undefined // not set return type for flattened property deserializer and type system will infer correct one
+      : resolveReference(refkey(type)),
     statements: ["return item;"]
   };
   const nullabilityPrefix = "";
@@ -365,7 +413,13 @@ function buildModelTypeDeserializer(
   const additionalPropertiesSpread =
     getAdditionalPropertiesStatement(context, type) ?? "";
 
-  const propertiesStr = getResponseMapping(context, type, "item");
+  const propertiesStr = getResponseMapping(
+    context,
+    type,
+    "item",
+    options.overrides,
+    !options.flatten
+  );
   const propertiesDeserialization = propertiesStr.filter((p) => p.trim());
 
   const output = [];
@@ -406,8 +460,10 @@ function getAdditionalPropertiesStatement(
   const deserializerFunction = buildModelDeserializer(
     context,
     additionalPropertyType,
-    false,
-    true
+    {
+      nameOnly: true,
+      skipDiscriminatedUnionSuffix: false
+    }
   );
   if (typeof deserializerFunction === "string") {
     params.push(deserializerFunction);
@@ -431,12 +487,10 @@ function buildDictTypeDeserializer(
   type: SdkDictionaryType,
   nameOnly = false
 ): FunctionDeclarationStructure | undefined | string {
-  const valueDeserializer = buildModelDeserializer(
-    context,
-    type.valueType,
-    false,
-    true
-  );
+  const valueDeserializer = buildModelDeserializer(context, type.valueType, {
+    nameOnly: true,
+    skipDiscriminatedUnionSuffix: false
+  });
   if (!valueDeserializer) {
     return undefined;
   }
@@ -490,12 +544,10 @@ function buildArrayTypeDeserializer(
   type: SdkArrayType,
   nameOnly = false
 ): FunctionDeclarationStructure | undefined | string {
-  const valueDeserializer = buildModelDeserializer(
-    context,
-    type.valueType,
-    false,
-    true
-  );
+  const valueDeserializer = buildModelDeserializer(context, type.valueType, {
+    nameOnly: true,
+    skipDiscriminatedUnionSuffix: false
+  });
   if (!valueDeserializer) {
     return undefined;
   }