@azure-tools/typespec-ts 0.54.0-dev.6 → 0.54.0-dev.8

package/src/modular/serialization/buildSerializerFunction.ts

@@ -1,4 +1,3 @@
-import { FunctionDeclarationStructure, StructureKind } from "ts-morph";
 import {
   SdkArrayType,
   SdkDictionaryType,
@@ -6,53 +5,44 @@ import {
   SdkModelType,
   SdkType,
   SdkUnionType,
-  UsageFlags
+  UsageFlags,
 } from "@azure-tools/typespec-client-generator-core";
+import { NoTarget } from "@typespec/compiler";
+import { isOrExtendsHttpFile } from "@typespec/http";
+import { FunctionDeclarationStructure, StructureKind } from "ts-morph";
+import { useContext } from "../../contextManager.js";
+import { resolveReference } from "../../framework/reference.js";
+import { refkey } from "../../framework/refkey.js";
+import { reportDiagnostic } from "../../lib.js";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import { SdkContext } from "../../utils/interfaces.js";
+import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
+import { getAdditionalPropertiesName, normalizeModelName } from "../emitModels.js";
 import {
   getAllAncestors,
   getAllProperties,
   getPropertyFullName,
   getRequestModelMapping,
-  getSerializationExpression
+  getSerializationExpression,
 } from "../helpers/operationHelpers.js";
-import {
-  getAdditionalPropertiesName,
-  normalizeModelName
-} from "../emitModels.js";
-import { NameType, normalizeName } from "../../rlc-common/index.js";
-import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
+import { getAdditionalPropertiesType, getDirectSubtypes } from "../helpers/typeHelpers.js";
+import { MultipartHelpers, SerializationHelpers } from "../static-helpers-metadata.js";
 import {
   getAllDiscriminatedValues,
   isDiscriminatedUnion,
   isSupportedSerializeType,
-  ModelSerializeOptions
+  ModelSerializeOptions,
 } from "./serializeUtils.js";
-import {
-  MultipartHelpers,
-  SerializationHelpers
-} from "../static-helpers-metadata.js";
-import { resolveReference } from "../../framework/reference.js";
-import { isOrExtendsHttpFile } from "@typespec/http";
-import { refkey } from "../../framework/refkey.js";
-import {
-  getAdditionalPropertiesType,
-  getDirectSubtypes
-} from "../helpers/typeHelpers.js";
-import { reportDiagnostic } from "../../lib.js";
-import { NoTarget } from "@typespec/compiler";
-import { useContext } from "../../contextManager.js";
 
 export function buildPropertySerializer(
   context: SdkContext,
   property: SdkModelPropertyType,
   options: ModelSerializeOptions = {
     nameOnly: false,
-    skipDiscriminatedUnionSuffix: false
-  }
+    skipDiscriminatedUnionSuffix: false,
+  },
 ) {
-  const propertyContext =
-    useContext("sdkTypes").flattenProperties.get(property);
+  const propertyContext = useContext("sdkTypes").flattenProperties.get(property);
   // only build de-serializer for flatten property
   if (property.flatten !== true || !propertyContext) {
     return undefined;
@@ -60,19 +50,19 @@ export function buildPropertySerializer(
   const predefinedName = `_${normalizeName(
     `${propertyContext.baseModel.name}_${property.name}`,
     NameType.Method,
-    true
+    true,
   )}Serializer`;
   return buildModelSerializer(context, property.type, {
     ...options,
     flatten: {
       baseModel: propertyContext.baseModel,
-      property
+      property,
     },
     overrides: {
       allOptional: property.optional,
-      propertyRenames: propertyContext.conflictMap
+      propertyRenames: propertyContext.conflictMap,
     },
-    predefinedName
+    predefinedName,
   });
 }
 
@@ -81,8 +71,8 @@ export function buildModelSerializer(
   type: SdkType,
   options: ModelSerializeOptions = {
     nameOnly: false,
-    skipDiscriminatedUnionSuffix: false
-  }
+    skipDiscriminatedUnionSuffix: false,
+  },
 ): FunctionDeclarationStructure | undefined | string {
   if (!isSupportedSerializeType(type)) {
     return undefined;
@@ -91,8 +81,7 @@ export function buildModelSerializer(
   if (type.kind === "model" || type.kind === "union" || type.kind === "enum") {
     if (
       !type.usage ||
-      (type.usage !== undefined &&
-        (type.usage & UsageFlags.Input) !== UsageFlags.Input)
+      (type.usage !== undefined && (type.usage & UsageFlags.Input) !== UsageFlags.Input)
     ) {
       return undefined;
     }
@@ -109,11 +98,7 @@ export function buildModelSerializer(
     }
   }
 
-  if (
-    !isDiscriminatedUnion(type) &&
-    type.kind === "model" &&
-    type.discriminatorProperty
-  ) {
+  if (!isDiscriminatedUnion(type) && type.kind === "model" && type.discriminatorProperty) {
     return buildPolymorphicSerializer(context, type, nameOnly);
   }
 
@@ -138,28 +123,28 @@ export function buildModelSerializer(
 function buildPolymorphicSerializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildPolymorphicSerializer(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): FunctionDeclarationStructure | undefined;
 function buildPolymorphicSerializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-serialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return undefined; // Return undefined to skip this serialization
   }
   const serializeFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Serializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "serializer"));
@@ -171,11 +156,11 @@ function buildPolymorphicSerializer(
     parameters: [
       {
         name: "item",
-        type: resolveReference(refkey(type, "polymorphicType"))
-      }
+        type: resolveReference(refkey(type, "polymorphicType")),
+      },
     ],
     returnType: "any",
-    statements: []
+    statements: [],
   };
   if (!type.discriminatorProperty) {
     return;
@@ -187,7 +172,7 @@ function buildPolymorphicSerializer(
     // No subtypes - treat as a regular model and generate simple serializer
     return buildModelTypeSerializer(context, type, {
       nameOnly,
-      skipDiscriminatedUnionSuffix: false
+      skipDiscriminatedUnionSuffix: false,
     });
   }
 
@@ -196,8 +181,7 @@ function buildPolymorphicSerializer(
     const subType = subTypes[discriminatedValue];
     if (
       !subType?.usage ||
-      (subType?.usage !== undefined &&
-        (subType.usage & UsageFlags.Input) !== UsageFlags.Input)
+      (subType?.usage !== undefined && (subType.usage & UsageFlags.Input) !== UsageFlags.Input)
     ) {
       return;
     }
@@ -205,7 +189,7 @@ function buildPolymorphicSerializer(
     if (!subType || !subType?.name) {
       reportDiagnostic(context.program, {
         code: "anonymous-type-serialization",
-        target: subType?.__raw || NoTarget
+        target: subType?.__raw || NoTarget,
       });
       return; // Skip this subtype
     }
@@ -214,7 +198,7 @@ function buildPolymorphicSerializer(
     const subtypeSerializerName = normalizeName(
       `${rawSubTypeName}_Serializer`,
       NameType.Method,
-      true
+      true,
     );
 
     cases.push(`
@@ -237,21 +221,21 @@ function buildPolymorphicSerializer(
 function buildDiscriminatedUnionSerializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildDiscriminatedUnionSerializer(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): FunctionDeclarationStructure | undefined;
 function buildDiscriminatedUnionSerializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-serialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return undefined; // Return undefined to skip this serialization
   }
@@ -260,7 +244,7 @@ function buildDiscriminatedUnionSerializer(
   const serializeFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Serializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "serializer"));
@@ -270,33 +254,24 @@ function buildDiscriminatedUnionSerializer(
     context,
     type,
     NameType.Operation,
-    true
+    true,
   )}Serializer`;
   const directSubtypes = getDirectSubtypes(type);
   for (const subType of directSubtypes) {
     if (
       !subType.usage ||
-      (subType.usage !== undefined &&
-        (subType.usage & UsageFlags.Input) !== UsageFlags.Input)
+      (subType.usage !== undefined && (subType.usage & UsageFlags.Input) !== UsageFlags.Input)
     ) {
       continue;
     }
     // get all discriminated values that is linked by this discriminator property
-    const discriminatedValues = getAllDiscriminatedValues(
-      subType,
-      type.discriminatorProperty
-    );
+    const discriminatedValues = getAllDiscriminatedValues(subType, type.discriminatorProperty);
     const union = subType.discriminatedSubtypes ? "Union" : "";
-    const subTypeName = normalizeModelName(
-      context,
-      subType,
-      NameType.Interface,
-      !union
-    );
+    const subTypeName = normalizeModelName(context, subType, NameType.Interface, !union);
     // Get the serializer name and ensure reference tracking
     const subtypeSerializerName = buildModelSerializer(context, subType, {
       nameOnly: true,
-      skipDiscriminatedUnionSuffix: false
+      skipDiscriminatedUnionSuffix: false,
     }) as string;
 
     const caseLabels = discriminatedValues.map((value) => `case "${value}":`);
@@ -320,40 +295,36 @@ function buildDiscriminatedUnionSerializer(
     parameters: [
       {
         name: "item",
-        type: resolveReference(refkey(type, "polymorphicType"))
-      }
+        type: resolveReference(refkey(type, "polymorphicType")),
+      },
     ],
     returnType: "any",
-    statements: output.join("\n")
+    statements: output.join("\n"),
   };
   return serializerFunction;
 }
 
+function buildUnionSerializer(context: SdkContext, type: SdkUnionType, nameOnly: boolean): string;
 function buildUnionSerializer(
   context: SdkContext,
   type: SdkUnionType,
-  nameOnly: boolean
-): string;
-function buildUnionSerializer(
-  context: SdkContext,
-  type: SdkUnionType
 ): FunctionDeclarationStructure;
 function buildUnionSerializer(
   context: SdkContext,
   type: SdkUnionType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-serialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return ""; // Return empty string to continue processing
   }
   const serializerFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Serializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "serializer"));
@@ -365,11 +336,11 @@ function buildUnionSerializer(
     parameters: [
       {
         name: "item",
-        type: resolveReference(refkey(type))
-      }
+        type: resolveReference(refkey(type)),
+      },
     ],
     returnType: "any",
-    statements: ["return item;"]
+    statements: ["return item;"],
   };
   return serializerFunction;
 }
@@ -379,13 +350,13 @@ function buildModelTypeSerializer(
   type: SdkModelType,
   options: ModelSerializeOptions = {
     nameOnly: false,
-    skipDiscriminatedUnionSuffix: false
-  }
+    skipDiscriminatedUnionSuffix: false,
+  },
 ): FunctionDeclarationStructure | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-deserialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return ""; // Return empty string to continue processing
   }
@@ -395,7 +366,7 @@ function buildModelTypeSerializer(
       context,
       type,
       NameType.Operation,
-      options.skipDiscriminatedUnionSuffix
+      options.skipDiscriminatedUnionSuffix,
     )}Serializer`;
   if (options.nameOnly) {
     return options.flatten
@@ -411,11 +382,11 @@ function buildModelTypeSerializer(
         name: "item",
         type: options.flatten
           ? resolveReference(refkey(options.flatten.baseModel))
-          : resolveReference(refkey(type))
-      }
+          : resolveReference(refkey(type)),
+      },
     ],
     returnType: "any",
-    statements: ["return item;"]
+    statements: ["return item;"],
   };
 
   if (
@@ -437,11 +408,9 @@ function buildModelTypeSerializer(
       const multipart = property.serializationOptions.multipart;
       if (multipart?.isFilePart) {
         const createFilePartDescriptorDefinition = resolveReference(
-          MultipartHelpers.createFilePartDescriptor
+          MultipartHelpers.createFilePartDescriptor,
         );
-        const itemPath = multipart.isMulti
-          ? "x"
-          : getPropertyFullName(context, property, "item");
+        const itemPath = multipart.isMulti ? "x" : getPropertyFullName(context, property, "item");
         partDefinition = `${createFilePartDescriptorDefinition}("${multipart.name}", ${itemPath}, )`;
 
         // If the TypeSpec doesn't specify a default content type, TCGC will infer a default of "*/*".
@@ -465,7 +434,7 @@ function buildModelTypeSerializer(
       }
       if (property.optional) {
         parts.push(
-          `...(${getPropertyFullName(context, property, "item")} === undefined ? [] : [${partDefinition}])`
+          `...(${getPropertyFullName(context, property, "item")} === undefined ? [] : [${partDefinition}])`,
         );
       } else {
         parts.push(partDefinition);
@@ -476,17 +445,14 @@ function buildModelTypeSerializer(
 
     serializerFunction.statements = [`return [${parts.join(",")}]`];
   } else {
-    const additionalPropertiesSpread = getAdditionalPropertiesStatement(
-      context,
-      type
-    );
+    const additionalPropertiesSpread = getAdditionalPropertiesStatement(context, type);
 
     const propertiesStr = getRequestModelMapping(
       context,
       type,
       "item",
       options.overrides,
-      !options.flatten
+      !options.flatten,
     );
 
     if (additionalPropertiesSpread) {
@@ -519,20 +485,16 @@ function buildModelTypeSerializer(
 
 function getAdditionalPropertiesStatement(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): string | undefined {
   const additionalPropertyType = getAdditionalPropertiesType(type);
   if (!additionalPropertyType) {
     return undefined;
   }
-  const deserializerFunction = buildModelSerializer(
-    context,
-    additionalPropertyType,
-    {
-      nameOnly: true,
-      skipDiscriminatedUnionSuffix: false
-    }
-  );
+  const deserializerFunction = buildModelSerializer(context, additionalPropertyType, {
+    nameOnly: true,
+    skipDiscriminatedUnionSuffix: false,
+  });
   const params = [`item.${getAdditionalPropertiesName(context, type)} ?? {}`];
   if (typeof deserializerFunction === "string") {
     params.push("undefined");
@@ -546,20 +508,20 @@ function getAdditionalPropertiesStatement(
 function buildDictTypeSerializer(
   context: SdkContext,
   type: SdkDictionaryType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildDictTypeSerializer(
   context: SdkContext,
-  type: SdkDictionaryType
+  type: SdkDictionaryType,
 ): FunctionDeclarationStructure | undefined;
 function buildDictTypeSerializer(
   context: SdkContext,
   type: SdkDictionaryType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   const valueSerializer = buildModelSerializer(context, type.valueType, {
     nameOnly: true,
-    skipDiscriminatedUnionSuffix: false
+    skipDiscriminatedUnionSuffix: false,
   });
   if (!valueSerializer) {
     return undefined;
@@ -582,8 +544,8 @@ function buildDictTypeSerializer(
     parameters: [
       {
         name: "item",
-        type: `Record<string, ${resolveReference(type.valueType) ?? "any"}>`
-      }
+        type: `Record<string, ${resolveReference(type.valueType) ?? "any"}>`,
+      },
     ],
     returnType: "Record<string, any>",
     statements: [
@@ -593,8 +555,8 @@ function buildDictTypeSerializer(
     result[key] = !item[key]? item[key]: ${valueSerializer}(item[key])
   });
   return result;
-      `
-    ]
+      `,
+    ],
   };
   return serializerFunction;
 }
@@ -602,20 +564,20 @@ function buildDictTypeSerializer(
 function buildArrayTypeSerializer(
   context: SdkContext,
   type: SdkArrayType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildArrayTypeSerializer(
   context: SdkContext,
-  type: SdkArrayType
+  type: SdkArrayType,
 ): FunctionDeclarationStructure | undefined;
 function buildArrayTypeSerializer(
   context: SdkContext,
   type: SdkArrayType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   const valueSerializer = buildModelSerializer(context, type.valueType, {
     nameOnly: true,
-    skipDiscriminatedUnionSuffix: false
+    skipDiscriminatedUnionSuffix: false,
   });
   if (!valueSerializer) {
     return undefined;
@@ -638,8 +600,8 @@ function buildArrayTypeSerializer(
     parameters: [
       {
         name: "result",
-        type: `Array<${normalizeModelName(context, type.valueType as any) ?? "any"}>`
-      }
+        type: `Array<${normalizeModelName(context, type.valueType as any) ?? "any"}>`,
+      },
     ],
     returnType: "any[]",
     statements: [
@@ -647,8 +609,8 @@ function buildArrayTypeSerializer(
   return result.map((item) => {
     return ${valueSerializer}(item)
   });
-      `
-    ]
+      `,
+    ],
   };
   return serializerFunction;
 }