Merge pull request #752 from Meraki-Solutions/partial-records

Records should be partial so we're not required to use all keys

src/__tests__/record.test.ts

@@ -17,17 +17,17 @@ const recordWithLiteralKeys = z.record(
 type recordWithLiteralKeys = z.infer<typeof recordWithLiteralKeys>;
 
 test("type inference", () => {
-  const f1: util.AssertEqual<booleanRecord, Record<string, boolean>> = true;
+  const f1: util.AssertEqual<booleanRecord, Partial<Record<string, boolean>>> = true;
   f1;
 
   const f2: util.AssertEqual<
     recordWithEnumKeys,
-    Record<"Tuna" | "Salmon", string>
+    Partial<Record<"Tuna" | "Salmon", string>>
   > = true;
   f2;
   const f3: util.AssertEqual<
     recordWithLiteralKeys,
-    Record<"Tuna" | "Salmon", string>
+    Partial<Record<"Tuna" | "Salmon", string>>
   > = true;
   f3;
 });
@@ -90,6 +90,22 @@ test("key schema", () => {
     Salmon: "asdf",
   });
 
+  // shouldn't require us to specify all props in record
+  const result3 = recordWithEnumKeys.parse({
+    Tuna: "abcd",
+  });
+  expect(result3).toEqual({
+    Tuna: "abcd",
+  });
+
+  // shouldn't require us to specify all props in record
+  const result4 = recordWithLiteralKeys.parse({
+    Salmon: "abcd",
+  });
+  expect(result4).toEqual({
+    Salmon: "abcd",
+  });
+
   expect(() =>
     recordWithEnumKeys.parse({
       Tuna: "asdf",

src/types.ts

@@ -2367,9 +2367,9 @@ export class ZodRecord<
   Key extends KeySchema = ZodString,
   Value extends ZodTypeAny = ZodTypeAny
 > extends ZodType<
-  Record<Key["_output"], Value["_output"]>,
+  Partial<Record<Key["_output"], Value["_output"]>>,
   ZodRecordDef<Key, Value>,
-  Record<Key["_input"], Value["_input"]>
+  Partial<Record<Key["_input"], Value["_input"]>>
 > {
   get keySchema() {
     return this._def.keyType;