zod-nest 3.5.0 → 3.6.0

package/dist/index.d.mts

@@ -300,10 +300,12 @@ type ResponseStatusWildcard = '1XX' | '2XX' | '3XX' | '4XX' | '5XX';
  * Description payload accepted by `@ZodResponse(...)` and passed through to
  * `applyZodNest`'s `@ApiResponse(...)` emitter. String form is shorthand for
  * `{ description }`; the object form lets users declare OpenAPI response
- * `headers` / `links` alongside the description.
+ * `summary` / `headers` / `links` alongside the description.
  */
 type ZodResponseDescription = string | {
     description: string;
+    /** 3.2-only. `applyZodNest` drops it, with a warning, when emitting 3.1. */
+    summary?: string;
     headers?: Record<string, unknown>;
     links?: Record<string, unknown>;
 };
@@ -818,6 +820,8 @@ interface ApplyZodNestOptions {
  *   `additionalOperations`, the only place that version accepts them, and
  *   rewrites `schema` to `itemSchema` on sequential media types (SSE, NDJSON, …)
  *   so a streamed body documents one item rather than the whole sequence.
+ * - Response Object `summary` survives only under 3.2; emitting 3.1 drops each
+ *   one with a warning naming the operation, since 3.1 forbids the field.
  *
  * Composable with other doc-transform passes — apply other mutations before
  * or after this function.

package/dist/index.d.ts

@@ -300,10 +300,12 @@ type ResponseStatusWildcard = '1XX' | '2XX' | '3XX' | '4XX' | '5XX';
  * Description payload accepted by `@ZodResponse(...)` and passed through to
  * `applyZodNest`'s `@ApiResponse(...)` emitter. String form is shorthand for
  * `{ description }`; the object form lets users declare OpenAPI response
- * `headers` / `links` alongside the description.
+ * `summary` / `headers` / `links` alongside the description.
  */
 type ZodResponseDescription = string | {
     description: string;
+    /** 3.2-only. `applyZodNest` drops it, with a warning, when emitting 3.1. */
+    summary?: string;
     headers?: Record<string, unknown>;
     links?: Record<string, unknown>;
 };
@@ -818,6 +820,8 @@ interface ApplyZodNestOptions {
  *   `additionalOperations`, the only place that version accepts them, and
  *   rewrites `schema` to `itemSchema` on sequential media types (SSE, NDJSON, …)
  *   so a streamed body documents one item rather than the whole sequence.
+ * - Response Object `summary` survives only under 3.2; emitting 3.1 drops each
+ *   one with a warning naming the operation, since 3.1 forbids the field.
  *
  * Composable with other doc-transform passes — apply other mutations before
  * or after this function.

package/dist/index.js

@@ -624,6 +624,9 @@ var extractDescriptionFields = /* @__PURE__ */ chunkEV5I5HGT_js.__name((desc) =>
   const out = {
     description: desc.description
   };
+  if (desc.summary !== void 0) {
+    out.summary = desc.summary;
+  }
   if (desc.headers !== void 0) {
     out.headers = desc.headers;
   }
@@ -1100,35 +1103,45 @@ var HTTP_METHODS = [
 ];
 var ADDITIONAL_OPERATIONS_KEY = "additionalOperations";
 var isRecord = /* @__PURE__ */ chunkEV5I5HGT_js.__name((value) => value !== null && typeof value === "object", "isRecord");
-var operationsOfPathItem = /* @__PURE__ */ chunkEV5I5HGT_js.__name((pathItem) => {
-  const operations = [];
+var operationEntriesOfPathItem = /* @__PURE__ */ chunkEV5I5HGT_js.__name((pathItem) => {
+  const entries = [];
   for (const method of HTTP_METHODS) {
     const operation = pathItem[method];
     if (isRecord(operation)) {
-      operations.push(operation);
+      entries.push({
+        method,
+        operation
+      });
     }
   }
   const additional = pathItem[ADDITIONAL_OPERATIONS_KEY];
   if (isRecord(additional)) {
-    for (const operation of Object.values(additional)) {
+    for (const [method, operation] of Object.entries(additional)) {
       if (isRecord(operation)) {
-        operations.push(operation);
+        entries.push({
+          method,
+          operation
+        });
       }
     }
   }
-  return operations;
-}, "operationsOfPathItem");
+  return entries;
+}, "operationEntriesOfPathItem");
+var operationsOfPathItem = /* @__PURE__ */ chunkEV5I5HGT_js.__name((pathItem) => operationEntriesOfPathItem(pathItem).map((entry) => entry.operation), "operationsOfPathItem");
 var forEachOperation = /* @__PURE__ */ chunkEV5I5HGT_js.__name((doc, fn) => {
   const paths = doc.paths;
   if (!isRecord(paths)) {
     return;
   }
-  for (const pathItem of Object.values(paths)) {
+  for (const [path, pathItem] of Object.entries(paths)) {
     if (!isRecord(pathItem)) {
       continue;
     }
-    for (const operation of operationsOfPathItem(pathItem)) {
-      fn(operation);
+    for (const { method, operation } of operationEntriesOfPathItem(pathItem)) {
+      fn(operation, {
+        path,
+        method
+      });
     }
   }
 }, "forEachOperation");
@@ -1921,6 +1934,30 @@ var addRefTitles = /* @__PURE__ */ chunkEV5I5HGT_js.__name((node, titleById) =>
   }
 }, "addRefTitles");
 
+// src/document/response-summary.ts
+var isRecord4 = /* @__PURE__ */ chunkEV5I5HGT_js.__name((value) => value !== null && typeof value === "object", "isRecord");
+var applyResponseSummary = /* @__PURE__ */ chunkEV5I5HGT_js.__name((doc, opts) => {
+  if (opts.emit) {
+    return;
+  }
+  forEachOperation(doc, (operation, { path, method }) => {
+    const responses = operation.responses;
+    if (!isRecord4(responses)) {
+      return;
+    }
+    for (const [status, response] of Object.entries(responses)) {
+      if (!isRecord4(response) || response.summary === void 0) {
+        continue;
+      }
+      delete response.summary;
+      warnDropped(method, path, status);
+    }
+  });
+}, "applyResponseSummary");
+var warnDropped = /* @__PURE__ */ chunkEV5I5HGT_js.__name((method, path, status) => {
+  console.warn(`[zod-nest] Dropped \`summary\` from \`${method.toUpperCase()} ${path}\` response \`${status}\`: OpenAPI 3.1 has no Response Object \`summary\` field. Declare 3.2 via \`DocumentBuilder.setOpenAPIVersion('3.2.0')\` to emit it.`);
+}, "warnDropped");
+
 // src/document/rewrite-refs.ts
 var rewriteRefs = /* @__PURE__ */ chunkEV5I5HGT_js.__name((params) => {
   const { doc, renames, divergentOutputIds } = params;
@@ -2069,11 +2106,15 @@ var applyZodNest = /* @__PURE__ */ chunkEV5I5HGT_js.__name((doc, opts = {}) => {
     collected: extended
   });
   const openApiVersion = resolveOpenApiVersion(doc);
-  if (openApiVersion.startsWith("3.2.")) {
+  const emitThirtyTwo = openApiVersion.startsWith("3.2.");
+  if (emitThirtyTwo) {
     relocateExtensionOperations(doc);
   }
   applyItemSchema(doc, {
-    emit: openApiVersion.startsWith("3.2.")
+    emit: emitThirtyTwo
+  });
+  applyResponseSummary(doc, {
+    emit: emitThirtyTwo
   });
   doc.openapi = openApiVersion;
   return doc;