typespec-http-zod 0.19.1 → 0.21.0

package/dist/src/api.d.ts

@@ -222,6 +222,22 @@ export interface EmittedRoute {
      * {@link rawBodyProperty}, whose case is the same statement about a different body.
      */
     readonly bodyProperty: string | undefined;
+    /**
+     * Whether the document publishes `requestBody.required: false`, so a request carrying NO body at
+     * all is one the contract permits.
+     *
+     * **A body that may be absent cannot be flattened into the input, which is why this is published
+     * rather than kept internal.** Merged, there is no way to say "these properties are here only
+     * sometimes" without making every one of them optional, which would be a different and weaker
+     * claim about the body that IS sent. So an optional body is named, exactly as an indexed one is,
+     * and a wrapping emitter spells the property optional from this.
+     *
+     * Measured before it existed: a bodyless `POST` naming `content-type: application/json` answered
+     * **400 `Malformed JSON in request body`** as `text/plain`, produced before the app's `invalid`
+     * hook and so outside its error envelope entirely - a service refusing a request its own contract
+     * permits, in a shape that contract forbids.
+     */
+    readonly optionalBody: boolean;
     /** Declared failures, each with the schema for its OWN body, in OpenAPI's precedence order. */
     readonly errorArms: readonly {
         readonly status: StatusKey;

package/dist/src/api.js

@@ -1054,7 +1054,12 @@ export function collectRoutes(program, registry, service) {
              * resolved model's own indexer rather than from the emitted schema text, which would be a
              * decision made by pattern-matching generated output.
              */
-            const bodyProperty = requestType?.kind === "Model" && requestType.indexer !== undefined
+            /**
+             * **An OPTIONAL body is named for the same reason an indexed one is**: the merge cannot
+             * express "absent". See {@link EmittedRoute.optionalBody}.
+             */
+            const optionalBody = bodyParameter?.property?.optional === true;
+            const bodyProperty = requestType?.kind === "Model" && (requestType.indexer !== undefined || optionalBody)
                 ? (bodyParameter?.property?.name ?? "body")
                 : undefined;
             routes.push({
@@ -1135,6 +1140,7 @@ export function collectRoutes(program, registry, service) {
                         : registry.expressionFor(responseType)),
                 rawBodyProperty,
                 bodyProperty,
+                optionalBody,
                 // Responses are read at Visibility.Read, exactly as the success body above is. Resolving
                 // them under the ambient request visibility declared six components under the wrong
                 // suffix - measured: type/model/visibility gained six divergences.
@@ -1653,8 +1659,21 @@ function renderRequestTypes(entries, responses, registry) {
     const lookup = entries
         .map((entry) => `\t${entry.operationId}: ${upperFirst(entry.operationId)}Input;`)
         .join("\n");
-    return `${generatedBanner()}
-/**
+    /**
+     * **Emitted only where an operation has something to flatten.**
+     *
+     * A generated file has to pass the lint of whatever project it lands in, and `noUnusedLocals`
+     * makes an unused type declaration an error. A service whose operations take no input at all -
+     * two parameterless `GET`s, which is where a health check starts and therefore where every new
+     * consumer starts - got this declaration and no use of it, so `requests.gen.ts` did not compile.
+     * `TS6196: 'Simplify' is declared but never used.` Third of its kind, after the unconditional
+     * `zValidator` and `z` imports.
+     *
+     * Decided from the aliases actually rendered rather than by searching the output for the name.
+     */
+    const simplifyHelper = inputs.length === 0
+        ? ""
+        : `/**
  * Flattens an intersection into a single object type.
  *
  * Without it, \`Body & { filingId: string }\` and the equivalent flat object are structurally the
@@ -1662,7 +1681,8 @@ function renderRequestTypes(entries, responses, registry) {
  * this file with the emitted Zod would fail on correct code.
  */
 type Simplify<T> = { [K in keyof T]: T[K] } & {};
-
+`;
+    return `${generatedBanner()}${simplifyHelper}
 /**
  * The same shape, tolerant of \`readonly\`.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespec-http-zod",
-  "version": "0.19.1",
+  "version": "0.21.0",
   "description": "TypeSpec emitter and library: turn an HTTP service definition into Zod validators and framework-free contract types that agree, keyword for keyword, with the OpenAPI document @typespec/openapi3 publishes from the same source.",
   "keywords": [
     "codegen",