Support additional properties in non-legacy Modular

packages/typespec-test/test/healthInsights_radiologyinsights/generated/typespec-ts/src/models/fhir/r4/models.ts

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { serializeRecord } from "../../../static-helpers/serialization/serialize-record.js";
+
 export function resourceArraySerializer(result: Array<Resource>): any[] {
   return result.map((item) => {
     return resourceSerializer(item);
@@ -34,7 +36,7 @@ export interface Resource {
 
 export function resourceSerializer(item: Resource): any {
   return {
-    ...item,
+    ...item.additionalProperties,
     resourceType: item["resourceType"],
     id: item["id"],
     meta: !item["meta"] ? item["meta"] : metaSerializer(item["meta"]),
@@ -45,7 +47,13 @@ export function resourceSerializer(item: Resource): any {
 
 export function resourceDeserializer(item: any): Resource {
   return {
-    ...item,
+    additionalProperties: serializeRecord(item, [
+      "resourceType",
+      "id",
+      "meta",
+      "implicitRules",
+      "language",
+    ]),
     resourceType: item["resourceType"],
     id: item["id"],
     meta: !item["meta"] ? item["meta"] : metaDeserializer(item["meta"]),
@@ -761,7 +769,47 @@ export interface Observation extends DomainResource {
 
 export function observationDeserializer(item: any): Observation {
   return {
-    ...item,
+    additionalProperties: serializeRecord(item, [
+      "resourceType",
+      "text",
+      "contained",
+      "extension",
+      "modifierExtension",
+      "id",
+      "meta",
+      "implicitRules",
+      "language",
+      "identifier",
+      "status",
+      "category",
+      "code",
+      "subject",
+      "encounter",
+      "effectiveDateTime",
+      "effectivePeriod",
+      "effectiveInstant",
+      "issued",
+      "valueQuantity",
+      "valueCodeableConcept",
+      "valueString",
+      "valueBoolean",
+      "valueInteger",
+      "valueRange",
+      "valueRatio",
+      "valueSampledData",
+      "valueTime",
+      "valueDateTime",
+      "valuePeriod",
+      "dataAbsentReason",
+      "interpretation",
+      "note",
+      "bodySite",
+      "method",
+      "referenceRange",
+      "hasMember",
+      "derivedFrom",
+      "component",
+    ]),
     resourceType: item["resourceType"],
     text: !item["text"] ? item["text"] : narrativeDeserializer(item["text"]),
     contained: !item["contained"]
@@ -1077,7 +1125,17 @@ export interface DomainResource extends Resource {
 
 export function domainResourceDeserializer(item: any): DomainResource {
   return {
-    ...item,
+    additionalProperties: serializeRecord(item, [
+      "resourceType",
+      "id",
+      "meta",
+      "implicitRules",
+      "language",
+      "text",
+      "contained",
+      "extension",
+      "modifierExtension",
+    ]),
     resourceType: item["resourceType"],
     id: item["id"],
     meta: !item["meta"] ? item["meta"] : metaDeserializer(item["meta"]),

packages/typespec-test/test/healthInsights_radiologyinsights/generated/typespec-ts/src/static-helpers/serialization/serialize-record.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+export function serializeRecord(item: any, excludeProperties: string[] = []) {
+  let res: any = {};
+  for (let key of Object.keys(item)) {
+    if (!excludeProperties.includes(key)) {
+      res[key] = item[key] as any;
+    }
+  }
+  return Object.keys(res).length === 0 ? undefined : res;
+}

packages/typespec-test/test/openai_generic/generated/typespec-ts/review/openai-generic.api.md

@@ -43,7 +43,8 @@ export interface ChatCompletionFunctionCallOption {
 }
 
 // @public
-export interface ChatCompletionFunctionParameters extends Record<string, any> {
+export interface ChatCompletionFunctionParameters {
+    additionalProperties?: Record<string, any>;
 }
 
 // @public

packages/typespec-test/test/openai_generic/generated/typespec-ts/src/models/models.ts

@@ -1923,12 +1923,15 @@ export function chatCompletionFunctionsSerializer(
 }
 
 /** model interface ChatCompletionFunctionParameters */
-export interface ChatCompletionFunctionParameters extends Record<string, any> {}
+export interface ChatCompletionFunctionParameters {
+  /** Additional properties */
+  additionalProperties?: Record<string, any>;
+}
 
 export function chatCompletionFunctionParametersSerializer(
   item: ChatCompletionFunctionParameters,
 ): any {
-  return { ...item };
+  return { ...item.additionalProperties };
 }
 
 /** Alias for _CreateChatCompletionRequestFunctionCall1 */

packages/typespec-test/test/openai_non_branded/generated/typespec-ts/review/openai-non-branded.api.md

@@ -43,7 +43,8 @@ export interface ChatCompletionFunctionCallOption {
 }
 
 // @public
-export interface ChatCompletionFunctionParameters extends Record<string, any> {
+export interface ChatCompletionFunctionParameters {
+    additionalProperties?: Record<string, any>;
 }
 
 // @public

packages/typespec-test/test/openai_non_branded/generated/typespec-ts/src/models/models.ts

@@ -1922,12 +1922,15 @@ export function chatCompletionFunctionsSerializer(
 }
 
 /** model interface ChatCompletionFunctionParameters */
-export interface ChatCompletionFunctionParameters extends Record<string, any> {}
+export interface ChatCompletionFunctionParameters {
+  /** Additional properties */
+  additionalProperties?: Record<string, any>;
+}
 
 export function chatCompletionFunctionParametersSerializer(
   item: ChatCompletionFunctionParameters,
 ): any {
-  return { ...item };
+  return { ...item.additionalProperties };
 }
 
 /** Alias for _CreateChatCompletionRequestFunctionCall1 */

packages/typespec-ts/src/lib.ts

@@ -394,12 +394,6 @@ const libDef = {
         default: paramMessage`Please note the header ${"type"} is not serializable.`
       }
     },
-    "compatible-additional-properties": {
-      severity: "warning",
-      messages: {
-        default: paramMessage`Please note that only compatible additional properties is supported for now. You can enable compatibilityMode to generate compatible additional properties for the model - ${"modelName"}.`
-      }
-    },
     "default-response-body-type": {
       severity: "warning",
       messages: {
@@ -453,6 +447,12 @@ const libDef = {
       messages: {
         default: paramMessage`Enum member name ${"memberName"} is normalized to ${"normalizedName"} with "_" prefix.`
       }
+    },
+    "property-name-conflict": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`The property name ${"propertyName"} has conflicts with others and please use @clientName to rename it.`
+      }
     }
   },
   emitter: {

packages/typespec-ts/src/modular/emitModels.ts

@@ -61,6 +61,8 @@ import {
 import { emitQueue } from "../framework/hooks/sdkTypes.js";
 import { resolveReference } from "../framework/reference.js";
 import { MultipartHelpers } from "./static-helpers-metadata.js";
+import { getAllAncestors } from "./helpers/operationHelpers.js";
+import { getAllProperties } from "./helpers/operationHelpers.js";
 
 type InterfaceStructure = OptionalKind<InterfaceDeclarationStructure> & {
   extends?: string[];
@@ -492,36 +494,50 @@ function addExtendedDictInfo(
   const additionalPropertiesType = model.additionalProperties
     ? getTypeExpression(context, model.additionalProperties)
     : undefined;
-  if (
-    (model.properties &&
-      model.properties.length > 0 &&
-      model.additionalProperties &&
-      model.properties?.every((p) => {
+  if (context.rlcOptions?.compatibilityMode) {
+    const ancestors = getAllAncestors(model);
+    const properties = getAllProperties(model, ancestors);
+    let anyType = true;
+    if (!additionalPropertiesType) {
+      // case 1: if additionalProperties is not defined, we should use any type
+      anyType = true;
+    } else if (properties.length === 0) {
+      // case 2: if additionalProperties is defined and model.properties is empty, we should use additionalProperties type
+      anyType = false;
+    } else {
+      // case 3: if additionalProperties is defined and model.properties is not empty, we should check if all properties are compatible with additionalProperties type
+      anyType = !properties.every((p) => {
         return additionalPropertiesType?.includes(
           getTypeExpression(context, p.type)
         );
-      })) ||
-    (model.properties?.length === 0 && model.additionalProperties)
-  ) {
-    modelInterface.extends = [
-      ...(modelInterface.extends ?? []),
-      `Record<string, ${additionalPropertiesType ?? "any"}>`
-    ];
-  } else if (context.rlcOptions?.compatibilityMode) {
+      });
+    }
     if (!modelInterface.extends) {
       modelInterface.extends = [];
     }
-    modelInterface.extends.push(`Record<string, any>`);
+    modelInterface.extends.push(
+      `Record<string, ${anyType ? "any" : additionalPropertiesType}>`
+    );
   } else {
-    reportDiagnostic(context.program, {
-      code: "compatible-additional-properties",
-      format: {
-        modelName: modelInterface?.name ?? ""
-      },
-      target: NoTarget
-    });
-    modelInterface.properties?.push({
-      name: "additionalProperties",
+    const additionalPropertiesType = model.additionalProperties
+      ? getTypeExpression(context, model.additionalProperties)
+      : undefined;
+    const name = getAdditionalPropertiesName(model);
+    if (name !== "additionalProperties") {
+      // report diagnostic for additionalProperties
+      reportDiagnostic(context.program, {
+        code: "property-name-conflict",
+        format: {
+          propertyName: "additionalProperties"
+        },
+        target: NoTarget
+      });
+    }
+    if (!modelInterface.properties) {
+      modelInterface.properties = [];
+    }
+    modelInterface.properties.push({
+      name,
       docs: ["Additional properties"],
       hasQuestionToken: true,
       isReadonly: false,
@@ -530,6 +546,15 @@ function addExtendedDictInfo(
   }
 }
 
+export function getAdditionalPropertiesName(model: SdkModelType): string {
+  const ancestors = getAllAncestors(model);
+  const properties = getAllProperties(model, ancestors);
+  const nameConflict = properties.find(
+    (p) => p.name === "additionalProperties"
+  );
+  return nameConflict ? "additionalPropertiesBag" : "additionalProperties";
+}
+
 export function normalizeModelName(
   context: SdkContext,
   type:

packages/typespec-ts/src/modular/serialization/buildDeserializerFunction.ts

@@ -8,15 +8,24 @@ import {
   UsageFlags
 } from "@azure-tools/typespec-client-generator-core";
 import { SdkContext } from "../../utils/interfaces.js";
-import { getResponseMapping } from "../helpers/operationHelpers.js";
-import { normalizeModelName } from "../emitModels.js";
+import {
+  getAllAncestors,
+  getAllProperties,
+  getResponseMapping
+} from "../helpers/operationHelpers.js";
+import {
+  getAdditionalPropertiesName,
+  normalizeModelName
+} from "../emitModels.js";
 import { NameType, normalizeName } from "@azure-tools/rlc-common";
 import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
 import {
   isDiscriminatedUnion,
   isSupportedSerializeType,
   ModelSerializeOptions
 } from "./serializeUtils.js";
+import { resolveReference } from "../../framework/reference.js";
+import { SerializationHelpers } from "../static-helpers-metadata.js";
 
 export function buildModelDeserializer(
   context: SdkContext,
@@ -347,10 +356,8 @@ function buildModelTypeDeserializer(
   };
   const nullabilityPrefix = "";
 
-  // This is only handling the compatibility mode, will need to update when we handle additionalProperties property.
-  const additionalPropertiesSpread = hasAdditionalProperties(type)
-    ? "...item,"
-    : "";
+  const additionalPropertiesSpread =
+    getAdditionalPropertiesStatement(context, type) ?? "";
 
   const propertiesStr = getResponseMapping(context, type, "item");
   const propertiesDeserialization = propertiesStr.filter((p) => p.trim());
@@ -375,6 +382,25 @@ function buildModelTypeDeserializer(
   return deserializerFunction;
 }
 
+function getAdditionalPropertiesStatement(
+  context: SdkContext,
+  type: SdkModelType
+): string | undefined {
+  const allParents = getAllAncestors(type);
+  const properties = getAllProperties(type, allParents);
+  const excludeProperties = properties
+    .filter((p) => !!p.name)
+    .map((p) => `"${p.name}"`);
+  const excludePropertiesStr =
+    excludeProperties.length > 0 ? `[${excludeProperties.join(",")}]` : "";
+  const additionalPropertiesName = getAdditionalPropertiesName(type);
+  return hasAdditionalProperties(type)
+    ? context.rlcOptions?.compatibilityMode === true
+      ? "...item,"
+      : `${additionalPropertiesName}: ${resolveReference(SerializationHelpers.serializeRecord)}(item, ${excludePropertiesStr}),`
+    : undefined;
+}
+
 function buildDictTypeDeserializer(
   context: SdkContext,
   type: SdkDictionaryType,