v24: Replacing usage of example() method in framework sources

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Version 24
 
+### v24.7.4
+
+- This patch fixes the issue for users facing `TypeError: .example is not a function`, but not using that method:
+  - It was reported that in some environments Zod plugin is not loaded correctly so that the usage of
+    `ZodType::example()` (plugin method) internally by the framework itself was causing this issue;
+  - This version fixes the problem by replacing the usage of `.example()` with `globalRegistry.add()`.
+
 ### v24.7.3
 
 - Fixed the depiction of the negative response to `HEAD` requests:

eslint.config.js

@@ -33,6 +33,13 @@ const importConcerns = [
   })),
 ];
 
+const compatibilityConerns = [
+  {
+    selector: "CallExpression > MemberExpression[property.name='example']",
+    message: "avoid using example() method to operate without zod plugin",
+  },
+];
+
 const performanceConcerns = [
   {
     selector: "ImportDeclaration[source.value=/assert/]", // #2169
@@ -210,6 +217,7 @@ export default tsPlugin.config(
         "warn",
         ...importConcerns,
         ...performanceConcerns,
+        ...compatibilityConerns,
       ],
     },
   },

express-zod-api/src/result-handler.ts

@@ -112,15 +112,17 @@ export const defaultResultHandler = new ResultHandler({
     }
     return responseSchema;
   },
-  negative: z
-    .object({
+  negative: () => {
+    const schema = z.object({
       status: z.literal("error"),
       error: z.object({ message: z.string() }),
-    })
-    .example({
-      status: "error",
-      error: { message: "Sample error message" },
-    }),
+    });
+    const examples: z.output<typeof schema>[] = [
+      { status: "error", error: { message: "Sample error message" } },
+    ];
+    globalRegistry.add(schema, { examples });
+    return schema;
+  },
   handler: ({ error, input, output, request, response, logger }) => {
     if (error) {
       const httpError = ensureHttpError(error);
@@ -169,9 +171,11 @@ export const arrayResultHandler = new ResultHandler({
     }
     return responseSchema;
   },
-  negative: {
-    schema: z.string().example("Sample error message"),
-    mimeType: "text/plain",
+  negative: () => {
+    const schema = z.string();
+    const examples: z.output<typeof schema>[] = ["Sample error message"];
+    globalRegistry.add(schema, { examples });
+    return { schema, mimeType: "text/plain" };
   },
   handler: ({ response, output, error, logger, request, input }) => {
     if (error) {