Fix Handling of Optional Zod Fields with NestJS Swagger

[BEARlogin]

Dear Anatine Team,

I've encountered an issue where optional object fields defined with Zod are incorrectly treated as required by NestJS Swagger. Upon investigation, I discovered that NestJS Swagger defaults to marking fields as required unless explicitly stated otherwise. This behavior leads to a discrepancy when integrating Zod schemas, as fields intended to be optional are handled as required.

Issue Example:

Consider the following schema, where both pagination and filter are intended as optional fields:

const schema = z.object({
  pagination: z
    .object({
      limit: z.number(),
      offset: z.number(),
    })
    .optional(),
  filter: z
    .object({
      category: z.string().uuid(),
      userId: z.string().uuid(),
    })
    .optional(),
  sort: z.object({
    field: z.string(),
    order: z.string(),
  }),
});

In this scenario, NestJS Swagger incorrectly applies required: true to all fields, ignoring the optional designation provided by Zod.

Proposed Solution:

To address this issue, we must explicitly set required: false for fields where schemaObject.required is undefined. This ensures that our intent of marking fields as optional is accurately reflected in the generated Swagger documentation.

I believe this adjustment will enhance the integration compatibility between Zod and NestJS Swagger, ensuring that optional fields are correctly recognized and treated as such.

I look forward to your feedback on this proposed fix.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ab4c5c6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 2 targets

• nx affected:test --base=origin/main --codeCoverage
• nx affected:lint --base=origin/main

---

Sent with 💌 from NxCloud.