added useTypeAssertions to support zod > 3.21.1

chrishoermann · Nov 8, 2023 · b818c0b · b818c0b
1 parent 0a9cd70
commit b818c0b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/packages/generator/Readme.md b/packages/generator/Readme.md
@@ -51,6 +51,7 @@ Be aware that some generator options have been removed, a few new ones have been
     - [`useDefaultValidators`](#usedefaultvalidators)
     - [`coerceDate`](#coercedate)
     - [`writeNullishInModelTypes`](#writenullishinmodeltypes)
+    - [`useTypeAssertions`](#usetypeassertions)
     - [`prismaClientPath`](#prismaclientpath)
   - [Skip schema generation](#skip-schema-generation)
   - [Custom Enums](#custom-enums)
@@ -556,6 +557,22 @@ generator zod {
 }
 ```
 
+### `useTypeAssertions`
+
+> default: false
+
+Since there is a known typscript error when using `zod` greater than `3.21.1` you can now use type assertions to circumvent the error and use the latest version of `zod`.
+
+> A WORD OF WARNING: Use this solution at your own risk! Because type assertions are circumventing the type system this can lead to unexpected behavior and runtime errors.
+> But since the types worked in `zod` version `3.21.1` and the error is a known issue in `zod` version `3.21.2` I think it might be a valid solution until the issue is resolved.
+
+```prisma
+generator zod {
+  // ...rest of config
+  useTypeAssertions = true
+}
+```
+
 ### `prismaClientPath`
 
 > default: `inferred from prisma schema path`

diff --git a/packages/generator/package.json b/packages/generator/package.json
@@ -1,6 +1,6 @@
 {
   "name": "zod-prisma-types",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Generates zod schemas from Prisma models with advanced validation",
   "author": "Chris Hörmann",
   "license": "MIT",