typespec-http-zod 0.15.1 → 0.17.0

package/dist/src/api.js

@@ -601,6 +601,29 @@ function alternateSchemaFor(operation, status, registry) {
  * document does not state AND reject what a server actually receives, since `c.req.parseBody()`
  * hands back a `File`. The type of a value is positional, exactly as its visibility is.
  */
+/**
+ * The TS type for a **multipart** request body, built from the same parts as its validator.
+ *
+ * **`requestBodyOf` returns a type only for `bodyKind === "single"`, so a multipart body reached the
+ * request type not at all.** Measured: `UploadInput` was `{ "Content-Type": "multipart/form-data" }`
+ * while the validator beside it was `z.object({ file: ..., alt: ... })` and the document published
+ * every part. Two artefacts from one program, contradicting each other.
+ *
+ * **Built from `body.parts`, not from the parts model.** Walking the model types each part as its
+ * `HttpPart<T>` wrapper - `file: {}` - where the validator unwraps to `T`. Mirroring
+ * {@link multipartSchemaOf} part for part, including `multi` as an array, `optional`, and a binary
+ * part as `unknown`, is what makes the two agree by construction rather than by coincidence.
+ */
+function multipartTsOf(body, registry) {
+    const entries = body.parts.map((part) => {
+        const type = part.body?.type;
+        const inner = type === undefined || isBinaryPart(type) ? "unknown" : registry.expressionFor(type);
+        const value = part.multi === true ? `(${inner})[]` : inner;
+        const optional = part.optional === true ? "?" : "";
+        return `\t${objectKey(part.name ?? "")}${optional}: ${value};`;
+    });
+    return entries.length === 0 ? "{}" : `{\n${entries.join("\n")}\n}`;
+}
 function multipartSchemaOf(body, registry) {
     const entries = body.parts.map((part) => {
         const type = part.body?.type;
@@ -619,7 +642,27 @@ function multipartSchemaOf(body, registry) {
     const name = named !== undefined && named.kind === "Model" && named.name !== "" ? named.name : undefined;
     return name === undefined ? shape : registry.declareNamed(name, () => shape);
 }
-/** `bytes`, or a model built on `File` - the parts openapi3 publishes as an empty schema. */
+/**
+ * `bytes`, or a model built on `File` - the parts openapi3 publishes as an empty schema.
+ *
+ * **A narrowed type for a `File` part was tried in `0.17.0` and reverted; do not try it again
+ * without reading this.** The ask was reasonable - `input.file.name` needs a cast today - and every
+ * way of granting it breaks something load-bearing:
+ *
+ * - `z.custom<FileLike>()` throws in `z.toJSONSchema` ("Custom types cannot be represented"),
+ *   which silently removes those schemas from the differential that compares this emitter's
+ *   validators against the document. Measured: four corpus schemas dropped out.
+ * - `z.unknown().refine(guard)` serialises fine and narrows correctly, but REJECTS a value the
+ *   published contract permits, and `test/vocabulary.test.ts` refuses it by class for that reason.
+ * - Narrowing the type without a check makes the two artefacts disagree and asserts a shape nothing
+ *   established.
+ *
+ * The root cause is upstream and visible in this package's own fixtures: `@typespec/openapi3`
+ * publishes a bare `{}` for a File part even in 3.1, where `contentMediaType` could express it, and
+ * even when the part declares a specific content type. **The day the document says what the part is,
+ * the validator may say it too and the type follows for free.** Until then `unknown` is the only
+ * honest answer, and a consumer narrows at the boundary.
+ */
 function isBinaryPart(type) {
     if (type.kind === "Scalar") {
         for (let scalar = type; scalar !== undefined; scalar = scalar.baseScalar) {
@@ -660,7 +703,9 @@ export function isRawBinaryMediaType(contentTypes) {
 /** The declared request body type, if the operation takes one. */
 function requestBodyOf(operation) {
     const body = operation.parameters.body;
-    return body?.bodyKind === "single" ? body.type : undefined;
+    if (body?.bodyKind === "single")
+        return body.type;
+    return undefined;
 }
 /**
  * Parameters are emitted as their **own** schemas rather than folded into the body, because the two
@@ -1421,6 +1466,9 @@ function collectRequestTypes(program, registry, service) {
             if (successStatusOf(operation) === undefined)
                 continue;
             const body = requestBodyOf(operation);
+            /** The parts of a multipart body, which `requestBodyOf` deliberately does not return. */
+            const multipartBody = operation.parameters.body;
+            const multipart = multipartBody?.bodyKind === "multipart" ? { parts: multipartBody.parts } : undefined;
             /**
              * Headers are part of the input too.
              *
@@ -1466,9 +1514,11 @@ function collectRequestTypes(program, registry, service) {
                 operationId: operationIdOf(program, operation.operation),
                 bodyRef: rawBody !== undefined
                     ? `{\n\t${rawBody}: ${rawBodyType};\n}`
-                    : body === undefined
-                        ? undefined
-                        : registry.expressionFor(body),
+                    : multipart !== undefined
+                        ? multipartTsOf(multipart, registry)
+                        : body === undefined
+                            ? undefined
+                            : registry.expressionFor(body),
                 extraProperties,
             });
         }
@@ -1563,6 +1613,10 @@ type Simplify<T> = { [K in keyof T]: T[K] } & {};
  * mutable one. Mutability is not a fact about a wire shape: it says nothing about what a caller
  * receives. Making the TARGET readonly accepts both, which is the permissive direction; the reverse
  * would reject every view a producer actually returns.
+ *
+ * No branch for functions, deliberately: the wire vocabulary is primitives, objects and arrays, so
+ * a call signature cannot appear here. Mapping one would yield \`{}\`, so the day something does
+ * carry a method - a narrowed multipart file part is the near miss - this needs one.
  */
 type Produced<T> = T extends readonly (infer Element)[]
 	? readonly Produced<Element>[]
@@ -1625,7 +1679,7 @@ function renderWireAssertions(schemas, types, entries, contractsPackage) {
     }
     if (paired.length === 0)
         return undefined;
-    const assertions = paired.map((pair) => `export type Assert${pair.name} = MustHold<Identical<z.infer<typeof ${pair.identifier}>, Contracts.${pair.name}>>;`);
+    const assertions = paired.map((pair) => `export type Assert${pair.name} = MustHold<Identical<Declared<z.infer<typeof ${pair.identifier}>>, Contracts.${pair.name}>>;`);
     return `${generatedBanner()}
 import type { z } from "zod";
 import type * as Contracts from "${contractsPackage}";
@@ -1642,6 +1696,45 @@ type Identical<A, B> = (<T>() => T extends A ? 1 : 2) extends <T>() => T extends
 	? true
 	: ["the emitted validator and the shared wire type describe different shapes"];
 
+/**
+ * A shape with its index signatures removed, at every depth.
+ *
+ * **The two sides of this contract differ on exactly one axis, deliberately.** For an open model the
+ * validator's output carries \`[key: string]: unknown\`, because a loose parse really does pass
+ * unknown keys through. The shared wire type does not, because it is a FLOOR - the properties a
+ * producer must supply - and an index signature there is an obligation on the producer rather than a
+ * description of the payload. TypeScript gives an interface no implicit index signature, so carrying
+ * it made the published shape unsatisfiable by most domain types.
+ *
+ * So this comparison is over DECLARED PROPERTIES, the only claim both sides make. **That the
+ * validator is open wherever the document is open has not stopped being checked** - it is asserted
+ * directly by the emitter's own suite now, instead of falling out of this comparison as a side
+ * effect. Every other kind of drift still fails here exactly as before.
+ *
+ * Applied to the INFERRED side only. If the shared type ever grew an index signature of its own that
+ * is a real disagreement, and this still catches it.
+ *
+ * Deep, because openness recurs: a nested open model puts one at every level, which is why a single
+ * spread never repaired the shape it was supposed to repair.
+ */
+type Declared<T> = T extends (...args: never[]) => unknown
+	? T
+	: T extends readonly (infer Element)[]
+		? T extends Element[]
+			? Declared<Element>[]
+			: readonly Declared<Element>[]
+		: T extends object
+			? {
+					[K in keyof T as string extends K
+						? never
+						: number extends K
+							? never
+							: symbol extends K
+								? never
+								: K]: Declared<T[K]>;
+				}
+			: T;
+
 /**
  * \u26a0\ufe0f **The constraint is what fails the build.** \`Identical<A, B> & true\` merely produces an odd
  * type when the two disagree, and a type alias to an odd type compiles fine \u2014 66 assertions that

package/dist/src/types.js

@@ -207,6 +207,25 @@ function modelToTs(program, model) {
      * Permissiveness is a statement about the VALIDATOR - what it lets through - not about what a
      * producer must contain. The contract type is the floor: these fields, at least.
      */
+    /**
+     * **`0.16.0` added the catchall here and `0.17.0` reverted it. Do not add it again.**
+     *
+     * The argument for it was that the document says `additionalProperties` and the validator says
+     * `.loose()`, so the type should say it too. Both of those state what is TOLERATED ON ARRIVAL. On
+     * the type it reads as an obligation on whoever PRODUCES the value, and TypeScript gives an
+     * interface no implicit index signature (microsoft/TypeScript#15300) - only a type alias gets one
+     * - so whether a consumer could satisfy our published shape came to depend on which keyword their
+     * own domain type happened to use, in files this emitter does not own.
+     *
+     * Measured on one consumer's document: **58 of 101 components open, 26 of those nesting another
+     * open component**, so the obligation cost a structural deep copy of the response tree per
+     * response. One spread satisfies one level and does not reach the next, which is the whole shape
+     * of the failure - see `test/contractshape/`.
+     *
+     * What arrives is still described honestly, on the surface derived from the validator:
+     * `schemas.gen.ts` exports `Exact<z.infer<typeof x>>`, which carries the index signature because
+     * a `.loose()` parse really does. Two surfaces, two directions, neither lying.
+     */
     return entries.length === 0 ? "{}" : `{\n${entries.join("\n")}\n}`;
 }
 /**

package/dist/src/zod.js

@@ -783,8 +783,13 @@ function modelToZod(program, model) {
      * Measured on Zod 4.4.3: `.strict()`, `.loose()` and `.catchall()` all read `shape` eagerly, so
      * each one fires the getter during module initialisation and throws `Cannot access 'X' before
      * initialization` - the very thing the getter exists to avoid. `z.strictObject` and
-     * `z.looseObject` take the same shape without reading it. The suffix form stays everywhere else,
-     * so a model that does not recurse emits exactly the text it emitted before.
+     * `z.looseObject` take the same shape without reading it.
+     *
+     * **So the constructor form is used wherever it exists, not only where a cycle forces it.** It is
+     * also what Zod 4 asks for: its own types say "Consider `z.looseObject(A.shape)` instead" on
+     * `.loose()` and `.strict()`, and `.passthrough()` is deprecated outright. Emitting one spelling
+     * means a model that gains a back edge later does not silently change form, and the eager-`shape`
+     * hazard above stops being something this walk has to keep reasoning about.
      *
      * **A TYPED catchall has no constructor form, and that used to be a refusal.** There is nowhere
      * safe to put the getter - `.catchall()` reads `shape` eagerly - so the cycle was reported as
@@ -796,11 +801,11 @@ function modelToZod(program, model) {
     const lazily = members.some((member) => member.deferred);
     const constructible = suffix === "" || suffix === ".loose()";
     const shape = entries.length === 0 ? "{}" : `{\n${entries.join("\n")}\n}`;
-    const body = lazily
-        ? constructible
-            ? `${suffix === ".loose()" ? "z.looseObject" : strict === ".strict()" ? "z.strictObject" : "z.object"}(${shape})`
-            : `z.lazy(() => z.object(${shape})${suffix}${strict})`
-        : `z.object(${shape})${suffix}${strict}`;
+    const body = constructible
+        ? `${suffix === ".loose()" ? "z.looseObject" : strict === ".strict()" ? "z.strictObject" : "z.object"}(${shape})`
+        : lazily
+            ? `z.lazy(() => z.object(${shape})${suffix}${strict})`
+            : `z.object(${shape})${suffix}${strict}`;
     return applyConstraints(program, body, model);
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespec-http-zod",
-  "version": "0.15.1",
+  "version": "0.17.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",