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

package/src/modular/helpers/typeHelpers.ts

@@ -1,32 +1,25 @@
-import { NameType, normalizeName } from "../../rlc-common/index.js";
 import {
   SdkBodyParameter,
   SdkCredentialParameter,
   SdkEndpointParameter,
   SdkMethodParameter,
   SdkModelType,
-  SdkType
+  SdkType,
 } from "@azure-tools/typespec-client-generator-core";
-import {
-  getPropertyWithOverrides,
-  ModelOverrideOptions
-} from "../serialization/serializeUtils.js";
-import { getAllAncestors, getAllProperties } from "./operationHelpers.js";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import { SdkContext } from "../../utils/interfaces.js";
+import { getPropertyWithOverrides, ModelOverrideOptions } from "../serialization/serializeUtils.js";
+import { getAllAncestors, getAllProperties } from "./operationHelpers.js";
 
 export function getDirectSubtypes(type: SdkModelType) {
   if (!type.discriminatedSubtypes) {
     return [];
   }
   // Filter out subtypes that extend from other discriminated subtypes (hierarchical inheritance)
-  return Object.values(type.discriminatedSubtypes).filter(
-    (subtype) => subtype.baseModel === type
-  );
+  return Object.values(type.discriminatedSubtypes).filter((subtype) => subtype.baseModel === type);
 }
 
-export function getAdditionalPropertiesType(
-  type: SdkType | undefined
-): SdkType | undefined {
+export function getAdditionalPropertiesType(type: SdkType | undefined): SdkType | undefined {
   if (
     !type ||
     !(
@@ -75,7 +68,7 @@ const NumericTypeKinds = [
   "float32",
   "float64",
   "decimal",
-  "decimal128"
+  "decimal128",
 ];
 
 const DateTimeTypeKinds = ["plainTime"];
@@ -90,7 +83,7 @@ export function isDateTimeTypeKind(kind: string): boolean {
 }
 
 export function isCredentialType(
-  type: SdkEndpointParameter | SdkCredentialParameter | SdkMethodParameter
+  type: SdkEndpointParameter | SdkCredentialParameter | SdkMethodParameter,
 ): boolean {
   return type.kind === "credential";
 }
@@ -102,17 +95,13 @@ export function isCredentialType(
 export function buildPropertyNameMapper(
   context: SdkContext,
   model: SdkType,
-  overrides?: ModelOverrideOptions
+  overrides?: ModelOverrideOptions,
 ) {
   const mapper = new Map<string, string>();
   if (model.kind !== "model") {
     return mapper;
   }
-  const allProperties = getAllProperties(
-    context,
-    model,
-    getAllAncestors(model)
-  );
+  const allProperties = getAllProperties(context, model, getAllAncestors(model));
   for (const p of allProperties) {
     if (p.kind !== "property") {
       continue;
@@ -120,7 +109,7 @@ export function buildPropertyNameMapper(
     const prop = getPropertyWithOverrides(p, overrides);
     mapper.set(
       prop.serializationOptions.json?.name || prop.name,
-      normalizeName(prop.name, NameType.Property)
+      normalizeName(prop.name, NameType.Property),
     );
   }
   return mapper;

package/src/modular/serialization/buildDeserializerFunction.ts

@@ -1,4 +1,3 @@
-import { FunctionDeclarationStructure, StructureKind } from "ts-morph";
 import {
   SdkArrayType,
   SdkDictionaryType,
@@ -6,48 +5,42 @@ import {
   SdkModelType,
   SdkType,
   SdkUnionType,
-  UsageFlags
+  UsageFlags,
 } from "@azure-tools/typespec-client-generator-core";
+import { NoTarget } from "@typespec/compiler";
+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,
   getPropertySerializedName,
-  getResponseMapping
+  getResponseMapping,
 } 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 { SerializationHelpers } from "../static-helpers-metadata.js";
 import {
   getAllDiscriminatedValues,
   isDiscriminatedUnion,
   isSupportedSerializeType,
-  ModelSerializeOptions
+  ModelSerializeOptions,
 } from "./serializeUtils.js";
-import { SerializationHelpers } from "../static-helpers-metadata.js";
-import { refkey } from "../../framework/refkey.js";
-import { resolveReference } from "../../framework/reference.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 buildPropertyDeserializer(
   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;
@@ -56,19 +49,19 @@ export function buildPropertyDeserializer(
   const predefinedName = `_${normalizeName(
     `${propertyContext.baseModel.name}_${property.name}`,
     NameType.Method,
-    true
+    true,
   )}Deserializer`;
   return buildModelDeserializer(context, property.type, {
     ...options,
     flatten: {
       baseModel: propertyContext.baseModel,
-      property
+      property,
     },
     overrides: {
       allOptional: property.optional,
-      propertyRenames: propertyContext.conflictMap
+      propertyRenames: propertyContext.conflictMap,
     },
-    predefinedName
+    predefinedName,
   });
 }
 
@@ -77,8 +70,8 @@ export function buildModelDeserializer(
   type: SdkType,
   options: ModelSerializeOptions = {
     nameOnly: false,
-    skipDiscriminatedUnionSuffix: false
-  }
+    skipDiscriminatedUnionSuffix: false,
+  },
 ): FunctionDeclarationStructure | undefined | string {
   // const modelTcgcType = getTcgcType(type) as SdkModelType;
   if (!isSupportedSerializeType(type)) {
@@ -104,11 +97,7 @@ export function buildModelDeserializer(
     }
   }
 
-  if (
-    !isDiscriminatedUnion(type) &&
-    type.kind === "model" &&
-    type.discriminatorProperty
-  ) {
+  if (!isDiscriminatedUnion(type) && type.kind === "model" && type.discriminatorProperty) {
     return buildPolymorphicDeserializer(context, type, nameOnly);
   }
 
@@ -133,28 +122,28 @@ export function buildModelDeserializer(
 function buildPolymorphicDeserializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildPolymorphicDeserializer(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): FunctionDeclarationStructure | undefined;
 function buildPolymorphicDeserializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-deserialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return undefined; // Return undefined to skip this deserialization
   }
   const deserializeFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Deserializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "deserializer"));
@@ -166,11 +155,11 @@ function buildPolymorphicDeserializer(
     parameters: [
       {
         name: "item",
-        type: "any"
-      }
+        type: "any",
+      },
     ],
     returnType: resolveReference(refkey(type, "polymorphicType")),
-    statements: []
+    statements: [],
   };
   if (!type.discriminatorProperty) {
     return;
@@ -182,7 +171,7 @@ function buildPolymorphicDeserializer(
     // No subtypes - treat as a regular model and generate simple deserializer
     return buildModelTypeDeserializer(context, type, {
       nameOnly,
-      skipDiscriminatedUnionSuffix: false
+      skipDiscriminatedUnionSuffix: false,
     });
   }
 
@@ -191,8 +180,7 @@ function buildPolymorphicDeserializer(
     const subType = subTypes[discriminatedValue];
     if (
       !subType?.usage ||
-      (subType?.usage !== undefined &&
-        (subType.usage & UsageFlags.Output) !== UsageFlags.Output)
+      (subType?.usage !== undefined && (subType.usage & UsageFlags.Output) !== UsageFlags.Output)
     ) {
       return;
     }
@@ -200,7 +188,7 @@ function buildPolymorphicDeserializer(
     if (!subType || !subType?.name) {
       reportDiagnostic(context.program, {
         code: "anonymous-type-deserialization",
-        target: subType?.__raw || NoTarget
+        target: subType?.__raw || NoTarget,
       });
       return; // Skip this subtype
     }
@@ -210,7 +198,7 @@ function buildPolymorphicDeserializer(
     const subtypeDeserializerName = normalizeName(
       `${subTypeName}Deserializer`,
       NameType.Operation,
-      true
+      true,
     );
 
     cases.push(`
@@ -220,9 +208,7 @@ function buildPolymorphicDeserializer(
   });
 
   // Use wire format name for the switch since item is raw JSON from the service
-  const discriminatorWireName = getPropertySerializedName(
-    type.discriminatorProperty
-  );
+  const discriminatorWireName = getPropertySerializedName(type.discriminatorProperty);
   statements.push(`
       switch (item["${discriminatorWireName}"]) {
        ${cases.join("\n")}
@@ -237,21 +223,21 @@ function buildPolymorphicDeserializer(
 function buildDiscriminatedUnionDeserializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildDiscriminatedUnionDeserializer(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): FunctionDeclarationStructure | undefined;
 function buildDiscriminatedUnionDeserializer(
   context: SdkContext,
   type: SdkModelType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   if (!type.name) {
     reportDiagnostic(context.program, {
       code: "anonymous-type-deserialization",
-      target: type.__raw || NoTarget
+      target: type.__raw || NoTarget,
     });
     return undefined; // Return undefined to skip this deserialization
   }
@@ -260,7 +246,7 @@ function buildDiscriminatedUnionDeserializer(
   const deserializeFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Deserializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "deserializer"));
@@ -270,33 +256,24 @@ function buildDiscriminatedUnionDeserializer(
     context,
     type,
     NameType.Operation,
-    true
+    true,
   )}Deserializer`;
   const directSubtypes = getDirectSubtypes(type);
   for (const subType of directSubtypes) {
     if (
       !subType.usage ||
-      (subType.usage !== undefined &&
-        (subType.usage & UsageFlags.Output) !== UsageFlags.Output)
+      (subType.usage !== undefined && (subType.usage & UsageFlags.Output) !== UsageFlags.Output)
     ) {
       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 deserializer name and ensure reference tracking
     const subtypeDeserializerName = buildModelDeserializer(context, subType, {
       nameOnly: true,
-      skipDiscriminatedUnionSuffix: false
+      skipDiscriminatedUnionSuffix: false,
     }) as string;
 
     const caseLabels = discriminatedValues.map((value) => `case "${value}":`);
@@ -324,40 +301,36 @@ function buildDiscriminatedUnionDeserializer(
     parameters: [
       {
         name: "item",
-        type: "any"
-      }
+        type: "any",
+      },
     ],
     returnType: resolveReference(refkey(type, "polymorphicType")),
-    statements: output.join("\n")
+    statements: output.join("\n"),
   };
   return deserializerFunction;
 }
 
+function buildUnionDeserializer(context: SdkContext, type: SdkUnionType, nameOnly: boolean): string;
 function buildUnionDeserializer(
   context: SdkContext,
   type: SdkUnionType,
-  nameOnly: boolean
-): string;
-function buildUnionDeserializer(
-  context: SdkContext,
-  type: SdkUnionType
 ): FunctionDeclarationStructure;
 function buildUnionDeserializer(
   context: SdkContext,
   type: SdkUnionType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | string | undefined {
   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
   }
   const deserializerFunctionName = `${normalizeModelName(
     context,
     type,
-    NameType.Operation
+    NameType.Operation,
   )}Deserializer`;
   if (nameOnly) {
     return resolveReference(refkey(type, "deserializer"));
@@ -369,11 +342,11 @@ function buildUnionDeserializer(
     parameters: [
       {
         name: "item",
-        type: "any"
-      }
+        type: "any",
+      },
     ],
     returnType: resolveReference(refkey(type)),
-    statements: ["return item;"]
+    statements: ["return item;"],
   };
   return deserializerFunction;
 }
@@ -383,13 +356,13 @@ function buildModelTypeDeserializer(
   type: SdkModelType,
   options: ModelSerializeOptions = {
     nameOnly: false,
-    skipDiscriminatedUnionSuffix: false
-  }
+    skipDiscriminatedUnionSuffix: false,
+  },
 ): FunctionDeclarationStructure | string | undefined {
   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
   }
@@ -399,7 +372,7 @@ function buildModelTypeDeserializer(
       context,
       type,
       NameType.Operation,
-      options.skipDiscriminatedUnionSuffix
+      options.skipDiscriminatedUnionSuffix,
     )}Deserializer`;
   if (options.nameOnly) {
     return options.flatten
@@ -413,25 +386,24 @@ function buildModelTypeDeserializer(
     parameters: [
       {
         name: "item",
-        type: "any"
-      }
+        type: "any",
+      },
     ],
     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;"]
+    statements: ["return item;"],
   };
   const nullabilityPrefix = "";
 
-  const additionalPropertiesSpread =
-    getAdditionalPropertiesStatement(context, type) ?? "";
+  const additionalPropertiesSpread = getAdditionalPropertiesStatement(context, type) ?? "";
 
   const propertiesStr = getResponseMapping(
     context,
     type,
     "item",
     options.overrides,
-    !options.flatten
+    !options.flatten,
   );
   const propertiesDeserialization = propertiesStr.filter((p) => p.trim());
 
@@ -457,7 +429,7 @@ function buildModelTypeDeserializer(
 
 function getAdditionalPropertiesStatement(
   context: SdkContext,
-  type: SdkModelType
+  type: SdkModelType,
 ): string | undefined {
   const additionalPropertyType = getAdditionalPropertiesType(type);
   if (!additionalPropertyType) {
@@ -465,19 +437,13 @@ function getAdditionalPropertiesStatement(
   }
   const allParents = getAllAncestors(type);
   const properties = getAllProperties(context, type, allParents);
-  const excludeProperties = properties
-    .filter((p) => !!p.name)
-    .map((p) => `"${p.name}"`);
+  const excludeProperties = properties.filter((p) => !!p.name).map((p) => `"${p.name}"`);
   const params = ["item"];
   params.push(`[${excludeProperties.join(",")}]`);
-  const deserializerFunction = buildModelDeserializer(
-    context,
-    additionalPropertyType,
-    {
-      nameOnly: true,
-      skipDiscriminatedUnionSuffix: false
-    }
-  );
+  const deserializerFunction = buildModelDeserializer(context, additionalPropertyType, {
+    nameOnly: true,
+    skipDiscriminatedUnionSuffix: false,
+  });
   if (typeof deserializerFunction === "string") {
     params.push(deserializerFunction);
   }
@@ -489,20 +455,20 @@ function getAdditionalPropertiesStatement(
 function buildDictTypeDeserializer(
   context: SdkContext,
   type: SdkDictionaryType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildDictTypeDeserializer(
   context: SdkContext,
-  type: SdkDictionaryType
+  type: SdkDictionaryType,
 ): FunctionDeclarationStructure | undefined;
 function buildDictTypeDeserializer(
   context: SdkContext,
   type: SdkDictionaryType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   const valueDeserializer = buildModelDeserializer(context, type.valueType, {
     nameOnly: true,
-    skipDiscriminatedUnionSuffix: false
+    skipDiscriminatedUnionSuffix: false,
   });
   if (!valueDeserializer) {
     return undefined;
@@ -526,8 +492,8 @@ function buildDictTypeDeserializer(
     parameters: [
       {
         name: "item",
-        type: "Record<string, any>"
-      }
+        type: "Record<string, any>",
+      },
     ],
     returnType: `Record<string, ${resolveReference(refkey(type.valueType)) ?? "any"}>`,
     statements: [
@@ -537,8 +503,8 @@ function buildDictTypeDeserializer(
     result[key] = !item[key]? item[key]: ${valueDeserializer}(item[key])
   });
   return result;
-      `
-    ]
+      `,
+    ],
   };
   return deserializerFunction;
 }
@@ -546,20 +512,20 @@ function buildDictTypeDeserializer(
 function buildArrayTypeDeserializer(
   context: SdkContext,
   type: SdkArrayType,
-  nameOnly: boolean
+  nameOnly: boolean,
 ): string;
 function buildArrayTypeDeserializer(
   context: SdkContext,
-  type: SdkArrayType
+  type: SdkArrayType,
 ): FunctionDeclarationStructure | undefined;
 function buildArrayTypeDeserializer(
   context: SdkContext,
   type: SdkArrayType,
-  nameOnly = false
+  nameOnly = false,
 ): FunctionDeclarationStructure | undefined | string {
   const valueDeserializer = buildModelDeserializer(context, type.valueType, {
     nameOnly: true,
-    skipDiscriminatedUnionSuffix: false
+    skipDiscriminatedUnionSuffix: false,
   });
   if (!valueDeserializer) {
     return undefined;
@@ -582,8 +548,8 @@ function buildArrayTypeDeserializer(
     parameters: [
       {
         name: "result",
-        type: `Array<${normalizeModelName(context, type.valueType as any) ?? "any"}>`
-      }
+        type: `Array<${normalizeModelName(context, type.valueType as any) ?? "any"}>`,
+      },
     ],
     returnType: "any[]",
     statements: [
@@ -591,8 +557,8 @@ function buildArrayTypeDeserializer(
   return result.map((item) => {
     return ${valueDeserializer}(item)
   });
-      `
-    ]
+      `,
+    ],
   };
   return serializerFunction;
 }