Skip to main content
Module

x/zod/__tests__/record.test.ts

TypeScript-first schema validation with static type inference
Extremely Popular
Go to Latest
File
// @ts-ignore TS6133import { expect } from "https://deno.land/x/expect@v0.2.6/mod.ts";const test = Deno.test;
import { util } from "../helpers/util.ts";import * as z from "../index.ts";
const booleanRecord = z.record(z.boolean());type booleanRecord = z.infer<typeof booleanRecord>;
const recordWithEnumKeys = z.record(z.enum(["Tuna", "Salmon"]), z.string());type recordWithEnumKeys = z.infer<typeof recordWithEnumKeys>;
const recordWithLiteralKeys = z.record( z.union([z.literal("Tuna"), z.literal("Salmon")]), z.string());type recordWithLiteralKeys = z.infer<typeof recordWithLiteralKeys>;
test("type inference", () => { util.assertEqual<booleanRecord, Record<string, boolean>>(true);
util.assertEqual< recordWithEnumKeys, Partial<Record<"Tuna" | "Salmon", string>> >(true);
util.assertEqual< recordWithLiteralKeys, Partial<Record<"Tuna" | "Salmon", string>> >(true);});
test("methods", () => { booleanRecord.optional(); booleanRecord.nullable();});
test("string record parse - pass", () => { booleanRecord.parse({ k1: true, k2: false, 1234: false, });});
test("string record parse - fail", () => { const badCheck = () => booleanRecord.parse({ asdf: 1234, } as any); expect(badCheck).toThrow();
expect(() => booleanRecord.parse("asdf")).toThrow();});
test("string record parse - fail", () => { const badCheck = () => booleanRecord.parse({ asdf: {}, } as any); expect(badCheck).toThrow();});
test("string record parse - fail", () => { const badCheck = () => booleanRecord.parse({ asdf: [], } as any); expect(badCheck).toThrow();});
test("key schema", () => { const result1 = recordWithEnumKeys.parse({ Tuna: "asdf", Salmon: "asdf", }); expect(result1).toEqual({ Tuna: "asdf", Salmon: "asdf", });
const result2 = recordWithLiteralKeys.parse({ Tuna: "asdf", Salmon: "asdf", }); expect(result2).toEqual({ Tuna: "asdf", 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", Salmon: "asdf", Trout: "asdf", }) ).toThrow();
expect(() => recordWithLiteralKeys.parse({ Tuna: "asdf", Salmon: "asdf",
Trout: "asdf", }) ).toThrow();});
// test("record element", () => {// expect(booleanRecord.element).toBeInstanceOf(z.ZodBoolean);// });
test("key and value getters", () => { const rec = z.record(z.string(), z.number());
rec.keySchema.parse("asdf"); rec.valueSchema.parse(1234); rec.element.parse(1234);});
test("is not vulnerable to prototype pollution", async () => { const rec = z.record( z.object({ a: z.string(), }) );
const data = JSON.parse(` { "__proto__": { "a": "evil" }, "b": { "a": "good" } } `);
const obj1 = rec.parse(data); expect(obj1.a).toBeUndefined();
const obj2 = rec.safeParse(data); expect(obj2.success).toBe(true); if (obj2.success) { expect(obj2.data.a).toBeUndefined(); }
const obj3 = await rec.parseAsync(data); expect(obj3.a).toBeUndefined();
const obj4 = await rec.safeParseAsync(data); expect(obj4.success).toBe(true); if (obj4.success) { expect(obj4.data.a).toBeUndefined(); }});
test("dont parse undefined values", () => { const result1 = z.record(z.any()).parse({ foo: undefined });
expect(result1).toEqual({ foo: undefined, });});