feat: Support Record<T, U> (#161)

* chore: update eslint * feat: support Record<T, U>
fabien0102 · Oct 17, 2023 · ac24784 · ac24784
1 parent 8d3b297
commit ac24784
Show file tree

Hide file tree

Showing 4 changed files with 298 additions and 187 deletions.
diff --git a/package.json b/package.json
@@ -75,7 +75,7 @@
     "auto-changelog": "^2.2.1",
     "babel-jest": "^27.5.1",
     "codecov": "^3.8.3",
-    "eslint": "^7.22.0",
+    "eslint": "^8.51.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "husky": "^5.2.0",

diff --git a/src/core/generateZodSchema.test.ts b/src/core/generateZodSchema.test.ts
@@ -291,13 +291,6 @@ describe("generateZodSchema", () => {
     );
   });
 
-  it("should throw on non string record", () => {
-    const source = `export type UnsupportedType = Record<number, number>;`;
-    expect(() => generate(source)).toThrowErrorMatchingInlineSnapshot(
-      `"Record<number, …> are not supported (https://github.com/colinhacks/zod/tree/v3#records)"`
-    );
-  });
-
   it("should throw on not supported key in omit", () => {
     const source = `export type UnsupportedType = Omit<Superman, Krytonite>;`;
     expect(() => generate(source)).toThrowErrorMatchingInlineSnapshot(
@@ -540,6 +533,16 @@ describe("generateZodSchema", () => {
     );
   });
 
+  it("should deal with record with a union as key", () => {
+    const source = `
+    export type AvailablePower = Record<Power, boolean>;
+    `;
+
+    expect(generate(source)).toMatchInlineSnapshot(
+      `"export const availablePowerSchema = z.record(powerSchema, z.boolean());"`
+    );
+  });
+
   it("should deal with index access type (tuple)", () => {
     const source = `export type SupermanPower = Superman["powers"][1];
 

diff --git a/src/core/generateZodSchema.ts b/src/core/generateZodSchema.ts
@@ -353,20 +353,44 @@ function buildZodPrimitive({
 
     // Deal with `Record<>` syntax
     if (identifierName === "Record" && typeNode.typeArguments) {
-      if (
-        typeNode.typeArguments.length !== 2 ||
-        typeNode.typeArguments[0].kind !== ts.SyntaxKind.StringKeyword
-      ) {
-        throw new Error(
-          `Record<${typeNode.typeArguments[0].getText(
-            sourceFile
-          )}, …> are not supported (https://github.com/colinhacks/zod/tree/v3#records)`
+      if (typeNode.typeArguments[0].kind === ts.SyntaxKind.StringKeyword) {
+        // Short version (`z.record(zodType)`)
+        return buildZodSchema(
+          z,
+          "record",
+          [
+            buildZodPrimitive({
+              z,
+              typeNode: typeNode.typeArguments[1],
+              isOptional: false,
+              jsDocTags,
+              sourceFile,
+              isPartial: false,
+              dependencies,
+              getDependencyName,
+              skipParseJSDoc,
+            }),
+          ],
+          zodProperties
         );
       }
+
+      // Expanded version (`z.record(zodType, zodType)`)
       return buildZodSchema(
         z,
         "record",
         [
+          buildZodPrimitive({
+            z,
+            typeNode: typeNode.typeArguments[0],
+            isOptional: false,
+            jsDocTags,
+            sourceFile,
+            isPartial: false,
+            dependencies,
+            getDependencyName,
+            skipParseJSDoc,
+          }),
           buildZodPrimitive({
             z,
             typeNode: typeNode.typeArguments[1],