Better Optional Handling (#11)

* Add question token for optional properties * Update tests to reflect correct handling of optionals * update snapshots Co-authored-by: Sachin Raja <sachinraja2349@gmail.com>
sachinraja · Apr 26, 2022 · 813872d · 813872d
1 parent ed65bcc
commit 813872d
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 8 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -85,12 +85,16 @@ const zodToTsNode = (
       const properties = Object.entries(zod._def.shape())
 
       const members: ts.TypeElement[] = properties.map(([key, value]) => {
-        const type = zodToTsNode(value as ZodTypeAny, ...otherArgs)
+        const nextZodNode = value as ZodTypeAny
+        const type = zodToTsNode(nextZodNode, ...otherArgs)
+
+        const { typeName: nextZodNodeTypeName } = nextZodNode._def
+        const isOptional = nextZodNodeTypeName === 'ZodOptional' || nextZodNode.isOptional()
 
         return f.createPropertySignature(
           undefined,
           f.createIdentifier(key),
-          undefined,
+          isOptional ? f.createToken(ts.SyntaxKind.QuestionToken) : undefined,
           type,
         )
       })

diff --git a/test/modifiers.test.ts b/test/modifiers.test.ts
@@ -5,12 +5,47 @@ import { printNodeTest } from './utils'
 
 const OptionalStringSchema = z.string().optional()
 
-describe('z.optional()', () => {
-  const { node } = zodToTs(OptionalStringSchema)
+const ObjectWithOptionals = z.object({
+  optional: OptionalStringSchema,
+  required: z.string(),
+  transform: z.number().optional().transform((arg) => arg),
+  or: z.number().optional().or(z.string()),
+  tuple: z.tuple([
+    z.string().optional(),
+    z.number(),
+    z.object({
+      optional: z.string().optional(),
+      required: z.string(),
+    }),
+  ]).optional(),
+})
 
+describe('z.optional()', () => {
   it('outputs correct typescript', () => {
+    const { node } = zodToTs(OptionalStringSchema)
     expect(printNodeTest(node)).toMatchInlineSnapshot('"string | undefined"')
   })
+
+  it('for optionals should output ?: property as well as undefined union', () => {
+    const { node } = zodToTs(ObjectWithOptionals)
+
+    expect(printNodeTest(node)).toMatchInlineSnapshot(`
+      "{
+          optional?: string | undefined;
+          required: string;
+          transform?: number | undefined;
+          or?: (number | undefined) | string;
+          tuple?: [
+              string | undefined,
+              number,
+              {
+                  optional?: string | undefined;
+                  required: string;
+              }
+          ] | undefined;
+      }"
+    `)
+  })
 })
 
 const NullableUsernameSchema = z.object({

diff --git a/test/primitive.test.ts b/test/primitive.test.ts
@@ -26,11 +26,11 @@ describe('PrimitiveSchema', () => {
           age: number;
           isAdmin: boolean;
           createdAt: Date;
-          undef: undefined;
+          undef?: undefined;
           nu: null;
-          vo: void | undefined;
-          an: any;
-          unknow: unknown;
+          vo?: void | undefined;
+          an?: any;
+          unknow?: unknown;
           nev: never;
       }"
     `)