From 1eb40be612915bb2037a67630ec3ce710d76e4bb Mon Sep 17 00:00:00 2001
From: s1gr1d <sigrid.huemer@posteo.at>
Date: Tue, 12 Aug 2025 14:09:04 +0200
Subject: [PATCH] docs(JS): Add docs for ZodErrors

---
 .../configuration/integrations/zodErrors.mdx  | 63 +++++++++++++++++++
 .../integrations/javascript.astro.mdx         |  1 +
 .../integrations/javascript.aws-lambda.mdx    |  1 +
 .../integrations/javascript.bun.mdx           |  1 +
 .../integrations/javascript.connect.mdx       |  1 +
 .../integrations/javascript.deno.mdx          |  1 +
 .../integrations/javascript.fastify.mdx       |  3 +-
 .../integrations/javascript.gcp-functions.mdx |  1 +
 .../integrations/javascript.hapi.mdx          |  1 +
 .../integrations/javascript.nestjs.mdx        |  1 +
 .../integrations/javascript.nextjs.mdx        |  1 +
 .../integrations/javascript.node.mdx          |  1 +
 .../integrations/javascript.nuxt.mdx          |  1 +
 .../integrations/javascript.remix.mdx         |  1 +
 .../integrations/javascript.solidstart.mdx    |  1 +
 .../integrations/javascript.sveltekit.mdx     |  1 +
 16 files changed, 79 insertions(+), 1 deletion(-)
 create mode 100644 docs/platforms/javascript/common/configuration/integrations/zodErrors.mdx

diff --git a/docs/platforms/javascript/common/configuration/integrations/zodErrors.mdx b/docs/platforms/javascript/common/configuration/integrations/zodErrors.mdx
new file mode 100644
index 0000000000000..64faa145cc4a5
--- /dev/null
+++ b/docs/platforms/javascript/common/configuration/integrations/zodErrors.mdx
@@ -0,0 +1,63 @@
+---
+title: ZodErrors
+description: "Adds additional data to Zod validation errors."
+---
+
+_Import name: `Sentry.zodErrorsIntegration`_
+
+The Zod Errors integration enhances error reporting for applications using [Zod](https://zod.dev/) schema validation.
+When Zod validation fails, this integration captures detailed validation errors (`ZodError` instances) and attaches them
+as additional data to Sentry events.
+
+The Zod Errors integration is not enabled by default. You need to add it to your Sentry configuration:
+
+```javascript
+Sentry.init({
+  integrations: [
+    Sentry.zodErrorsIntegration(),
+  ],
+});
+```
+
+## Options
+
+The `zodErrorsIntegration` accepts the following options:
+
+### `limit`
+
+_Type: `number`_
+_Default: `10`_
+
+Limits the number of Zod errors inlined in each Sentry event.
+
+### `saveZodIssuesAsAttachment`
+
+_Type: `boolean`_
+_Default: `false`_
+
+Save full list of Zod issues as a JSON attachment in Sentry.
+
+## Example Additional Error Data
+
+When a Zod validation error occurs, you'll see enhanced error information in Sentry like this:
+
+```json
+[
+  {
+    "code": "too_small",
+    "path": ["name"],
+    "message": "Name is required",
+    "minimum": 1,
+    "type": "string",
+    "inclusive": true,
+    "received": ""
+  },
+  {
+    "code": "invalid_string",
+    "path": ["email"],
+    "message": "Invalid email format",
+    "validation": "email",
+    "received": "invalid-email"
+  }
+]
+```
diff --git a/platform-includes/configuration/integrations/javascript.astro.mdx b/platform-includes/configuration/integrations/javascript.astro.mdx
index 6714b5150fe30..90e8b5b4b36e8 100644
--- a/platform-includes/configuration/integrations/javascript.astro.mdx
+++ b/platform-includes/configuration/integrations/javascript.astro.mdx
@@ -82,3 +82,4 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx
index fcb6851d4025a..c651e0e005f7c 100644
--- a/platform-includes/configuration/integrations/javascript.aws-lambda.mdx
+++ b/platform-includes/configuration/integrations/javascript.aws-lambda.mdx
@@ -44,3 +44,4 @@
 | [`rewriteFramesIntegration`](./rewriteframes)             |                  |     ✓      |             |                        |
 | [`tediousIntegration`](./tedious)                         |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.bun.mdx b/platform-includes/configuration/integrations/javascript.bun.mdx
index ad44371c98bac..adb1b87b7b004 100644
--- a/platform-includes/configuration/integrations/javascript.bun.mdx
+++ b/platform-includes/configuration/integrations/javascript.bun.mdx
@@ -38,3 +38,4 @@
 | [`rewriteFramesIntegration`](./rewriteframes)             |                  |     ✓      |             |                        |
 | [`supabaseIntegration`](./supabase)                       |                  |     ✓      |      ✓      |                        |     |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.connect.mdx b/platform-includes/configuration/integrations/javascript.connect.mdx
index e767b5dcad9bd..a4ea9fe6a8853 100644
--- a/platform-includes/configuration/integrations/javascript.connect.mdx
+++ b/platform-includes/configuration/integrations/javascript.connect.mdx
@@ -43,3 +43,4 @@
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`prismaIntegration`](./prisma)                           |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.deno.mdx b/platform-includes/configuration/integrations/javascript.deno.mdx
index bd9fb65d4d7e2..c205945c03667 100644
--- a/platform-includes/configuration/integrations/javascript.deno.mdx
+++ b/platform-includes/configuration/integrations/javascript.deno.mdx
@@ -16,3 +16,4 @@
 | [`rewriteFramesIntegration`](./rewriteframes)       |                  |     ✓      |             |          |                        |
 | [`supabaseIntegration`](./supabase)                   |                  |     ✓      |      ✓      |            |                     |
 | [`trpcMiddleware`](./trpc)                          |                  |     ✓      |      ✓      |          |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.fastify.mdx b/platform-includes/configuration/integrations/javascript.fastify.mdx
index 37655ce773083..a623a812a7fe7 100644
--- a/platform-includes/configuration/integrations/javascript.fastify.mdx
+++ b/platform-includes/configuration/integrations/javascript.fastify.mdx
@@ -42,5 +42,6 @@
 | [`localVariablesIntegration`](./localvariables)           |                  |     ✓      |             |                        |
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`rewriteFramesIntegration`](./rewriteframes)             |                  |     ✓      |             |                        |
-| [`supabaseIntegration`](./supabase)                       |                  |     ✓      |      ✓      |                        |     |
+| [`supabaseIntegration`](./supabase)                       |                  |     ✓      |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx
index 8c47081af6886..355a57f5cf900 100644
--- a/platform-includes/configuration/integrations/javascript.gcp-functions.mdx
+++ b/platform-includes/configuration/integrations/javascript.gcp-functions.mdx
@@ -44,3 +44,4 @@
 | [`rewriteFramesIntegration`](./rewriteframes)             |                  |     ✓      |             |                        |
 | [`tediousIntegration`](./tedious)                         |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.hapi.mdx b/platform-includes/configuration/integrations/javascript.hapi.mdx
index fdb2607e09a41..d1367197ccb9e 100644
--- a/platform-includes/configuration/integrations/javascript.hapi.mdx
+++ b/platform-includes/configuration/integrations/javascript.hapi.mdx
@@ -44,3 +44,4 @@
 | [`rewriteFramesIntegration`](./rewriteframes)             |                  |     ✓      |             |                        |
 | [`supabaseIntegration`](./supabase)                       |                  |     ✓      |      ✓      |                        |     |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.nestjs.mdx b/platform-includes/configuration/integrations/javascript.nestjs.mdx
index 9e85b0fab02ac..0b02ea2e59039 100644
--- a/platform-includes/configuration/integrations/javascript.nestjs.mdx
+++ b/platform-includes/configuration/integrations/javascript.nestjs.mdx
@@ -45,3 +45,4 @@
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`unleashIntegration`](./unleash)                         |                  |            |             |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.nextjs.mdx b/platform-includes/configuration/integrations/javascript.nextjs.mdx
index de0210f691ca7..82d24b9d2629b 100644
--- a/platform-includes/configuration/integrations/javascript.nextjs.mdx
+++ b/platform-includes/configuration/integrations/javascript.nextjs.mdx
@@ -88,6 +88,7 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`vercelAiIntegration`](./vercelai)                       |        ✓         |            |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
 
 ### Edge Integrations
 
diff --git a/platform-includes/configuration/integrations/javascript.node.mdx b/platform-includes/configuration/integrations/javascript.node.mdx
index d9be6d22d671c..cab7202e8a80c 100644
--- a/platform-includes/configuration/integrations/javascript.node.mdx
+++ b/platform-includes/configuration/integrations/javascript.node.mdx
@@ -43,3 +43,4 @@
 | [`tediousIntegration`](./tedious)                         |        ✓         |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.nuxt.mdx b/platform-includes/configuration/integrations/javascript.nuxt.mdx
index 4b25f09ab5b0a..c05a7458bd397 100644
--- a/platform-includes/configuration/integrations/javascript.nuxt.mdx
+++ b/platform-includes/configuration/integrations/javascript.nuxt.mdx
@@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.remix.mdx b/platform-includes/configuration/integrations/javascript.remix.mdx
index 8849cca15c3a0..72f1e8329c5a5 100644
--- a/platform-includes/configuration/integrations/javascript.remix.mdx
+++ b/platform-includes/configuration/integrations/javascript.remix.mdx
@@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.solidstart.mdx b/platform-includes/configuration/integrations/javascript.solidstart.mdx
index f58c659fd8997..afd364ad44122 100644
--- a/platform-includes/configuration/integrations/javascript.solidstart.mdx
+++ b/platform-includes/configuration/integrations/javascript.solidstart.mdx
@@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`nodeProfilingIntegration`](./nodeprofiling)             |                  |            |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |
diff --git a/platform-includes/configuration/integrations/javascript.sveltekit.mdx b/platform-includes/configuration/integrations/javascript.sveltekit.mdx
index 82da16a61135f..3597a1348c7a8 100644
--- a/platform-includes/configuration/integrations/javascript.sveltekit.mdx
+++ b/platform-includes/configuration/integrations/javascript.sveltekit.mdx
@@ -81,3 +81,4 @@ Depending on whether an integration enhances the functionality of a particular r
 | [`supabaseIntegration`](./supabase)                       |                  |     ✓      |      ✓      |                        |
 | [`trpcMiddleware`](./trpc)                                |                  |     ✓      |      ✓      |           ✓            |
 | [`openAIIntegration`](./openai)                           |        ✓         |            |      ✓      |                        |
+| [`zodErrorsIntegration`](./zodErrors)                     |                  |            |             |           ✓            |