@azure-tools/typespec-ts 0.53.3 → 0.54.0

package/src/modular/helpers/operationHelpers.ts

@@ -48,7 +48,7 @@ import {
   getFixmeForMultilineDocs
 } from "./docsHelpers.js";
 import { AzurePollingDependencies } from "../external-dependencies.js";
-import { NameType, normalizeName } from "@azure-tools/rlc-common";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import {
   buildModelDeserializer,
   buildPropertyDeserializer
@@ -230,11 +230,14 @@ export function getDeserializePrivateFunction(
       type: resolveReference(refkey(operation, "response"))
     };
   } else if (response.type) {
+    // When response.optional is true, some HTTP responses have no body (e.g. 204), so
+    // the return type must include undefined to reflect that possibility.
+    const baseType = getTypeExpression(context, response.type);
     returnType = {
       name: (response as any).name ?? "",
-      type: getTypeExpression(context, response.type)
+      type: response.optional ? `${baseType} | undefined` : baseType
     };
-  } else if (isHeadAsBooleanOperation(context, operation)) {
+  } else if (isHeadAsBooleanOperation(operation)) {
     returnType = { name: "", type: "boolean" };
   } else {
     returnType = { name: "", type: "void" };
@@ -262,7 +265,7 @@ export function getDeserializePrivateFunction(
     dependencies.createRestError
   );
   statements.push(
-    `const expectedStatuses = ${getExpectedStatuses(operation, context)};`
+    `const expectedStatuses = ${getExpectedStatuses(operation)};`
   );
   statements.push(
     `if(!expectedStatuses.includes(result.status)){`,
@@ -301,6 +304,13 @@ export function getDeserializePrivateFunction(
   }
 
   if (deserializedType) {
+    // When the method response is optional (some HTTP responses have no body, e.g. 204),
+    // guard all body deserialization so we return undefined instead of throwing.
+    // This only applies to non-LRO, non-paging operations where the deserialized type
+    // comes from response.type (not from LRO metadata or paging).
+    const needsBodyGuard =
+      response.optional && !isLroOnly && !isLroAndPaging && !isPagingOnly;
+
     const contentTypes = operation.operation.responses[0]?.contentTypes ?? [];
     const isXml = isXmlPayload(contentTypes);
     const isDualFormat = hasDualFormatSupport(contentTypes);
@@ -319,6 +329,13 @@ export function getDeserializePrivateFunction(
       deserializedType.kind === "model" &&
       hasXmlSerialization(deserializedType)
     ) {
+      if (needsBodyGuard) {
+        statements.push(
+          `if (!result.body) {
+            return result.body as ${returnType.type};
+          }`
+        );
+      }
       const xmlDeserializerName = buildXmlModelDeserializer(
         context,
         deserializedType,
@@ -365,6 +382,13 @@ export function getDeserializePrivateFunction(
       }
     } else if (useXmlDeserialization) {
       // XML-only response
+      if (needsBodyGuard) {
+        statements.push(
+          `if (!result.body) {
+            return result.body as ${returnType.type};
+          }`
+        );
+      }
       const xmlDeserializerName = buildXmlModelDeserializer(
         context,
         deserializedType,
@@ -413,7 +437,7 @@ export function getDeserializePrivateFunction(
           statements.push(
             `return { blobBody: result.blobBody, readableStreamBody: result.readableStreamBody };`
           );
-        } else if (isHeadAsBooleanOperation(context, operation)) {
+        } else if (isHeadAsBooleanOperation(operation)) {
           // HEAD has no body; derive boolean from status code
           statements.push(`return { body: result.status.startsWith("2") };`);
         } else {
@@ -435,14 +459,21 @@ export function getDeserializePrivateFunction(
         };
       }
       if (deserializeFunctionName) {
-        statements.push(
-          `return ${deserializeFunctionName}(${deserializedRoot})${multipartCastSuffix}`
-        );
+        if (needsBodyGuard) {
+          // Use ternary form: return result.body ? deserializer(result.body) : undefined
+          statements.push(
+            `return ${deserializedRoot} ? ${deserializeFunctionName}(${deserializedRoot})${multipartCastSuffix} : undefined`
+          );
+        } else {
+          statements.push(
+            `return ${deserializeFunctionName}(${deserializedRoot})${multipartCastSuffix}`
+          );
+        }
       } else if (
         isAzureCoreErrorType(context.program, deserializedType.__raw)
       ) {
         statements.push(`return ${deserializedRoot}${multipartCastSuffix}`);
-      } else if (isHeadAsBooleanOperation(context, operation)) {
+      } else if (isHeadAsBooleanOperation(operation)) {
         // HEAD has no body; derive boolean from status code
         statements.push(`return result.status.startsWith("2");`);
       } else {
@@ -464,7 +495,7 @@ export function getDeserializePrivateFunction(
         );
       }
     }
-  } else if (isHeadAsBooleanOperation(context, operation)) {
+  } else if (isHeadAsBooleanOperation(operation)) {
     if (shouldWrap) {
       statements.push(`return { body: result.status.startsWith("2") };`);
     } else {
@@ -789,12 +820,12 @@ function getExceptionThrowStatement(
       const headerStmt = allHeaderCalls;
       if (exception.end) {
         return `if(statusCode >= ${exception.start} && statusCode <= ${exception.end}) {
-              error.details = ${deserializeExpr};
+              if(result.body) { error.details = ${deserializeExpr}; }
               ${headerStmt}
           }`;
       } else {
         return `if(statusCode === ${exception.start}) {
-             error.details = ${deserializeExpr};
+             if(result.body) { error.details = ${deserializeExpr}; }
              ${headerStmt}
           }`;
       }
@@ -807,7 +838,7 @@ function getExceptionThrowStatement(
           ? `${defaultXmlDeserializer}(result.body)`
           : `isXml ? ${defaultXmlDeserializer}(result.body) : ${defaultDeserializer}(result.body)`;
       statements.push(`else {
-        error.details = ${defaultDeserializeExpr};
+        if(result.body) { error.details = ${defaultDeserializeExpr}; }
         ${allHeaderCalls}
       }`);
     }
@@ -817,7 +848,7 @@ function getExceptionThrowStatement(
       if (defaultXmlDeserializer) {
         if (defaultIsXmlOnly) {
           statements.push(`const error = ${createRestErrorReference}(result);
-          error.details = ${defaultXmlDeserializer}(result.body);
+          if(result.body) { error.details = ${defaultXmlDeserializer}(result.body); }
           ${allHeaderCalls}`);
         } else {
           const isXmlContentTypeRef = resolveReference(
@@ -825,12 +856,12 @@ function getExceptionThrowStatement(
           );
           statements.push(`const error = ${createRestErrorReference}(result);
           const responseContentType = result.headers?.["content-type"] ?? "";
-          error.details = ${isXmlContentTypeRef}(responseContentType) ? ${defaultXmlDeserializer}(result.body) : ${defaultDeserializer}(result.body);
+          if(result.body) { error.details = ${isXmlContentTypeRef}(responseContentType) ? ${defaultXmlDeserializer}(result.body) : ${defaultDeserializer}(result.body); }
           ${allHeaderCalls}`);
         }
       } else {
         statements.push(`const error = ${createRestErrorReference}(result);
-        error.details = ${defaultDeserializer}(result.body);
+        if(result.body) { error.details = ${defaultDeserializer}(result.body); }
         ${allHeaderCalls}`);
       }
       statements.push("throw error;");
@@ -1042,14 +1073,22 @@ export function getOperationFunction(
       isResponseHeadersEnabled
     ) {
       // Build a composite type that includes both model and additional header properties
+      const baseCompositeType = buildCompositeResponseType(
+        context,
+        type,
+        responseHeaders
+      );
       returnType = {
         name: (type as any).name ?? "",
-        type: `${buildCompositeResponseType(context, type, responseHeaders)}`
+        type: response.optional
+          ? `${baseCompositeType} | undefined`
+          : baseCompositeType
       };
     } else {
+      const baseType = getTypeExpression(context, type!);
       returnType = {
         name: (type as any).name ?? "",
-        type: getTypeExpression(context, type!)
+        type: response.optional ? `${baseType} | undefined` : baseType
       };
     }
   } else if (hasHeaderOnlyResponse && isResponseHeadersEnabled) {
@@ -1058,7 +1097,7 @@ export function getOperationFunction(
       name: "",
       type: `${buildHeaderOnlyResponseType(context, responseHeaders)}`
     };
-  } else if (isHeadAsBooleanOperation(context, operation)) {
+  } else if (isHeadAsBooleanOperation(operation)) {
     returnType = { name: "", type: "boolean" };
   }
 
@@ -2988,17 +3027,10 @@ export function getPropertyFullName(
  * Get an expression representing an array of expected status codes for the operation
  * @param operation The operation
  */
-export function getExpectedStatuses(
-  operation: ServiceOperation,
-  context?: SdkContext
-): string {
+export function getExpectedStatuses(operation: ServiceOperation): string {
   let statusCodes = operation.operation.responses.map((x) => x.statusCodes);
-  // For HEAD + @responseAsBool / head-as-boolean, 404 is a valid "false" response.
-  if (
-    context &&
-    isHeadAsBooleanOperation(context, operation) &&
-    !statusCodes.includes(404)
-  ) {
+  // For HEAD + @responseAsBool, 404 is a valid "false" response.
+  if (isHeadAsBooleanOperation(operation) && !statusCodes.includes(404)) {
     statusCodes = [...statusCodes, 404];
   }
   // LROs may call the same path but with GET to get the operation status.
@@ -3219,15 +3251,11 @@ function isHeadOperation(operation: ServiceOperation): boolean {
   return operation.operation.verb.toLowerCase() === "head";
 }
 
-function isHeadAsBooleanOperation(
-  context: SdkContext,
-  operation: ServiceOperation
-): boolean {
+function isHeadAsBooleanOperation(operation: ServiceOperation): boolean {
   if (!isHeadOperation(operation)) return false;
   // @responseAsBool: TCGC promotes response.type to SdkBuiltInType { kind: "boolean" }
   if ((operation.response.type as any)?.kind === "boolean") return true;
-  // Legacy head-as-boolean emitter option (response.type remains void)
-  return !!context.rlcOptions?.headAsBoolean;
+  return false;
 }
 
 /**
@@ -3264,9 +3292,8 @@ export function checkWrapNonModelReturn(
 
   const { type } = operation.response;
   if (!type) {
-    // Special case: HEAD operation with void response → wrap as boolean { body: boolean }
-    // Triggered by head-as-boolean emitter option.
-    if (isHeadAsBooleanOperation(context, operation)) {
+    // Special case: HEAD operation with @responseAsBool and void response → wrap as boolean { body: boolean }
+    if (isHeadAsBooleanOperation(operation)) {
       return { shouldWrap: true, isBinary: false };
     }
     return noWrap; // void return type - no wrap needed
@@ -3320,10 +3347,6 @@ export function buildNonModelResponseTypeDeclaration(
        */
       readableStreamBody?: ${nodeReadableStreamRef};
   }`;
-  } else if (!operation.response.type && isHeadOperation(operation)) {
-    // HEAD as boolean: the body property is a boolean indicating if the resource exists.
-    // true = resource exists (2xx response), false = resource not found (e.g., 404)
-    typeBody = `{ body: boolean }`;
   } else {
     const returnType = getTypeExpression(context, operation.response.type!);
     typeBody = `{ body: ${returnType} }`;

package/src/modular/helpers/typeHelpers.ts

@@ -1,4 +1,4 @@
-import { NameType, normalizeName } from "@azure-tools/rlc-common";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import {
   SdkBodyParameter,
   SdkCredentialParameter,

package/src/modular/interfaces.ts

@@ -1,4 +1,4 @@
-import { RLCOptions } from "@azure-tools/rlc-common";
+import { RLCOptions } from "../rlc-common/index.js";
 
 export interface ModularOptions {
   sourceRoot: string;

package/src/modular/serialization/buildDeserializerFunction.ts

@@ -19,7 +19,7 @@ import {
   getAdditionalPropertiesName,
   normalizeModelName
 } from "../emitModels.js";
-import { NameType, normalizeName } from "@azure-tools/rlc-common";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
 import {
   getAllDiscriminatedValues,

package/src/modular/serialization/buildSerializerFunction.ts

@@ -20,7 +20,7 @@ import {
   getAdditionalPropertiesName,
   normalizeModelName
 } from "../emitModels.js";
-import { NameType, normalizeName } from "@azure-tools/rlc-common";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
 import {
   getAllDiscriminatedValues,

package/src/modular/serialization/buildXmlSerializerFunction.ts

@@ -18,7 +18,7 @@ import {
   normalizeModelName,
   getAdditionalPropertiesName
 } from "../emitModels.js";
-import { NameType } from "@azure-tools/rlc-common";
+import { NameType } from "../../rlc-common/index.js";
 import { isAzureCoreErrorType } from "../../utils/modelUtils.js";
 import {
   isSupportedSerializeType,

package/src/modular/type-expressions/get-type-expression.ts

@@ -8,7 +8,7 @@ import { getCredentialExpression } from "./get-credential-expression.js";
 import { getEnumExpression } from "./get-enum-expression.js";
 import { getModelExpression } from "./get-model-expression.js";
 import { getUnionExpression } from "./get-union-expression.js";
-import { NameType, normalizeName } from "@azure-tools/rlc-common";
+import { NameType, normalizeName } from "../../rlc-common/index.js";
 import { SdkContext } from "../../utils/interfaces.js";
 import { getNullableExpression } from "./get-nullable-expression.js";