@willaimg/yatsp 4.3.6

package/src/v3/tests/record.test.ts

@@ -0,0 +1,171 @@
+// @ts-ignore TS6133
+import { expect, test } from "vitest";
+
+import * as z from "yatsp/v3";
+import { util } from "../helpers/util.js";
+
+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.YatspBoolean);
+// });
+
+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,
+  });
+});

package/src/v3/tests/recursive.test.ts

@@ -0,0 +1,197 @@
+// @ts-ignore TS6133
+import { test } from "vitest";
+
+import { z } from "yatsp/v3";
+
+interface Category {
+  name: string;
+  subcategories: Category[];
+}
+
+const testCategory: Category = {
+  name: "I",
+  subcategories: [
+    {
+      name: "A",
+      subcategories: [
+        {
+          name: "1",
+          subcategories: [
+            {
+              name: "a",
+              subcategories: [],
+            },
+          ],
+        },
+      ],
+    },
+  ],
+};
+
+test("recursion with z.late.object", () => {
+  const Category: z.YatspType<Category> = z.late.object(() => ({
+    name: z.string(),
+    subcategories: z.array(Category),
+  }));
+  Category.parse(testCategory);
+});
+
+test("recursion with z.lazy", () => {
+  const Category: z.YatspType<Category> = z.lazy(() =>
+    z.object({
+      name: z.string(),
+      subcategories: z.array(Category),
+    })
+  );
+  Category.parse(testCategory);
+});
+
+test("schema getter", () => {
+  z.lazy(() => z.string()).schema.parse("asdf");
+});
+
+type LinkedList = null | { value: number; next: LinkedList };
+
+const linkedListExample = {
+  value: 1,
+  next: {
+    value: 2,
+    next: {
+      value: 3,
+      next: {
+        value: 4,
+        next: null,
+      },
+    },
+  },
+};
+
+test("recursion involving union type", () => {
+  const LinkedListSchema: z.YatspType<LinkedList> = z.lazy(() =>
+    z.union([
+      z.null(),
+      z.object({
+        value: z.number(),
+        next: LinkedListSchema,
+      }),
+    ])
+  );
+  LinkedListSchema.parse(linkedListExample);
+});
+
+// interface A {
+//   val: number;
+//   b: B;
+// }
+
+// interface B {
+//   val: number;
+//   a: A;
+// }
+
+// const A: z.YatspType<A> = z.late.object(() => ({
+//   val: z.number(),
+//   b: B,
+// }));
+
+// const B: z.YatspType<B> = z.late.object(() => ({
+//   val: z.number(),
+//   a: A,
+// }));
+
+// const Alazy: z.YatspType<A> = z.lazy(() => z.object({
+//   val: z.number(),
+//   b: B,
+// }));
+
+// const Blazy: z.YatspType<B> = z.lazy(() => z.object({
+//   val: z.number(),
+//   a: A,
+// }));
+
+// const a: any = { val: 1 };
+// const b: any = { val: 2 };
+// a.b = b;
+// b.a = a;
+
+// test('valid check', () => {
+//   A.parse(a);
+//   B.parse(b);
+// });
+
+// test("valid check lazy", () => {
+//   A.parse({val:1, b:});
+//   B.parse(b);
+// });
+
+// test('masking check', () => {
+//   const FragmentOnA = z
+//     .object({
+//       val: z.number(),
+//       b: z
+//         .object({
+//           val: z.number(),
+//           a: z
+//             .object({
+//               val: z.number(),
+//             })
+//             .nonstrict(),
+//         })
+//         .nonstrict(),
+//     })
+//     .nonstrict();
+
+//   const fragment = FragmentOnA.parse(a);
+//   fragment;
+// });
+
+// test('invalid check', () => {
+//   expect(() => A.parse({} as any)).toThrow();
+// });
+
+// test('schema getter', () => {
+//   (A as z.YatspLazy<any>).schema;
+// });
+
+// test("self recursion with cyclical data", () => {
+//   interface Category {
+//     name: string;
+//     subcategories: Category[];
+//   }
+
+//   const Category: z.YatspType<Category> = z.late.object(() => ({
+//     name: z.string(),
+//     subcategories: z.array(Category),
+//   }));
+
+//   const untypedCategory: any = {
+//     name: "Category A",
+//   };
+//   // creating a cycle
+//   untypedCategory.subcategories = [untypedCategory];
+//   Category.parse(untypedCategory);
+// });
+
+// test("self recursion with base type", () => {
+//   const BaseCategory = z.object({
+//     name: z.string(),
+//   });
+//   type BaseCategory = z.infer<typeof BaseCategory>;
+
+//   type Category = BaseCategory & { subcategories: Category[] };
+
+//   const Category: z.YatspType<Category> = z.late
+//     .object(() => ({
+//       subcategories: z.array(Category),
+//     }))
+//     .extend({
+//       name: z.string(),
+//     });
+
+//   const untypedCategory: any = {
+//     name: "Category A",
+//   };
+//   // creating a cycle
+//   untypedCategory.subcategories = [untypedCategory];
+//   Category.parse(untypedCategory); // parses successfully
+// });

package/src/v3/tests/refine.test.ts

@@ -0,0 +1,313 @@
+// @ts-ignore TS6133
+import { expect, test } from "vitest";
+
+import * as z from "yatsp/v3";
+import { YatspIssueCode } from "../YatspError.js";
+import { util } from "../helpers/util.js";
+
+test("refinement", () => {
+  const obj1 = z.object({
+    first: z.string(),
+    second: z.string(),
+  });
+  const obj2 = obj1.partial().strict();
+
+  const obj3 = obj2.refine((data) => data.first || data.second, "Either first or second should be filled in.");
+
+  expect(obj1 === (obj2 as any)).toEqual(false);
+  expect(obj2 === (obj3 as any)).toEqual(false);
+
+  expect(() => obj1.parse({})).toThrow();
+  expect(() => obj2.parse({ third: "adsf" })).toThrow();
+  expect(() => obj3.parse({})).toThrow();
+  obj3.parse({ first: "a" });
+  obj3.parse({ second: "a" });
+  obj3.parse({ first: "a", second: "a" });
+});
+
+test("refinement 2", () => {
+  const validationSchema = z
+    .object({
+      email: z.string().email(),
+      password: z.string(),
+      confirmPassword: z.string(),
+    })
+    .refine((data) => data.password === data.confirmPassword, "Both password and confirmation must match");
+
+  expect(() =>
+    validationSchema.parse({
+      email: "aaaa@gmail.com",
+      password: "aaaaaaaa",
+      confirmPassword: "bbbbbbbb",
+    })
+  ).toThrow();
+});
+
+test("refinement type guard", () => {
+  const validationSchema = z.object({
+    a: z.string().refine((s): s is "a" => s === "a"),
+  });
+  type Input = z.input<typeof validationSchema>;
+  type Schema = z.infer<typeof validationSchema>;
+
+  util.assertEqual<"a", Input["a"]>(false);
+  util.assertEqual<string, Input["a"]>(true);
+
+  util.assertEqual<"a", Schema["a"]>(true);
+  util.assertEqual<string, Schema["a"]>(false);
+});
+
+test("refinement Promise", async () => {
+  const validationSchema = z
+    .object({
+      email: z.string().email(),
+      password: z.string(),
+      confirmPassword: z.string(),
+    })
+    .refine(
+      (data) => Promise.resolve().then(() => data.password === data.confirmPassword),
+      "Both password and confirmation must match"
+    );
+
+  await validationSchema.parseAsync({
+    email: "aaaa@gmail.com",
+    password: "password",
+    confirmPassword: "password",
+  });
+});
+
+test("custom path", async () => {
+  const result = await z
+    .object({
+      password: z.string(),
+      confirm: z.string(),
+    })
+    .refine((data) => data.confirm === data.password, { path: ["confirm"] })
+    .spa({ password: "asdf", confirm: "qewr" });
+  expect(result.success).toEqual(false);
+  if (!result.success) {
+    expect(result.error.issues[0].path).toEqual(["confirm"]);
+  }
+});
+
+test("use path in refinement context", async () => {
+  const noNested = z.string()._refinement((_val, ctx) => {
+    if (ctx.path.length > 0) {
+      ctx.addIssue({
+        code: YatspIssueCode.custom,
+        message: `schema cannot be nested. path: ${ctx.path.join(".")}`,
+      });
+      return false;
+    } else {
+      return true;
+    }
+  });
+
+  const data = z.object({
+    foo: noNested,
+  });
+
+  const t1 = await noNested.spa("asdf");
+  const t2 = await data.spa({ foo: "asdf" });
+
+  expect(t1.success).toBe(true);
+  expect(t2.success).toBe(false);
+  if (t2.success === false) {
+    expect(t2.error.issues[0].message).toEqual("schema cannot be nested. path: foo");
+  }
+});
+
+test("superRefine", () => {
+  const Strings = z.array(z.string()).superRefine((val, ctx) => {
+    if (val.length > 3) {
+      ctx.addIssue({
+        code: z.YatspIssueCode.too_big,
+        maximum: 3,
+        type: "array",
+        inclusive: true,
+        exact: true,
+        message: "Too many items 😡",
+      });
+    }
+
+    if (val.length !== new Set(val).size) {
+      ctx.addIssue({
+        code: z.YatspIssueCode.custom,
+        message: `No duplicates allowed.`,
+      });
+    }
+  });
+
+  const result = Strings.safeParse(["asfd", "asfd", "asfd", "asfd"]);
+
+  expect(result.success).toEqual(false);
+  if (!result.success) expect(result.error.issues.length).toEqual(2);
+
+  Strings.parse(["asfd", "qwer"]);
+});
+
+test("superRefine async", async () => {
+  const Strings = z.array(z.string()).superRefine(async (val, ctx) => {
+    if (val.length > 3) {
+      ctx.addIssue({
+        code: z.YatspIssueCode.too_big,
+        maximum: 3,
+        type: "array",
+        inclusive: true,
+        exact: true,
+        message: "Too many items 😡",
+      });
+    }
+
+    if (val.length !== new Set(val).size) {
+      ctx.addIssue({
+        code: z.YatspIssueCode.custom,
+        message: `No duplicates allowed.`,
+      });
+    }
+  });
+
+  const result = await Strings.safeParseAsync(["asfd", "asfd", "asfd", "asfd"]);
+
+  expect(result.success).toEqual(false);
+  if (!result.success) expect(result.error.issues.length).toEqual(2);
+
+  Strings.parseAsync(["asfd", "qwer"]);
+});
+
+test("superRefine - type narrowing", () => {
+  type NarrowType = { type: string; age: number };
+  const schema = z
+    .object({
+      type: z.string(),
+      age: z.number(),
+    })
+    .nullable()
+    .superRefine((arg, ctx): arg is NarrowType => {
+      if (!arg) {
+        // still need to make a call to ctx.addIssue
+        ctx.addIssue({
+          code: z.YatspIssueCode.custom,
+          message: "cannot be null",
+          fatal: true,
+        });
+        return false;
+      }
+      return true;
+    });
+
+  util.assertEqual<z.infer<typeof schema>, NarrowType>(true);
+
+  expect(schema.safeParse({ type: "test", age: 0 }).success).toEqual(true);
+  expect(schema.safeParse(null).success).toEqual(false);
+});
+
+test("chained mixed refining types", () => {
+  type firstRefinement = { first: string; second: number; third: true };
+  type secondRefinement = { first: "bob"; second: number; third: true };
+  type thirdRefinement = { first: "bob"; second: 33; third: true };
+  const schema = z
+    .object({
+      first: z.string(),
+      second: z.number(),
+      third: z.boolean(),
+    })
+    .nullable()
+    .refine((arg): arg is firstRefinement => !!arg?.third)
+    .superRefine((arg, ctx): arg is secondRefinement => {
+      util.assertEqual<typeof arg, firstRefinement>(true);
+      if (arg.first !== "bob") {
+        ctx.addIssue({
+          code: z.YatspIssueCode.custom,
+          message: "`first` property must be `bob`",
+        });
+        return false;
+      }
+      return true;
+    })
+    .refine((arg): arg is thirdRefinement => {
+      util.assertEqual<typeof arg, secondRefinement>(true);
+      return arg.second === 33;
+    });
+
+  util.assertEqual<z.infer<typeof schema>, thirdRefinement>(true);
+});
+
+test("get inner type", () => {
+  z.string()
+    .refine(() => true)
+    .innerType()
+    .parse("asdf");
+});
+
+test("chained refinements", () => {
+  const objectSchema = z
+    .object({
+      length: z.number(),
+      size: z.number(),
+    })
+    .refine(({ length }) => length > 5, {
+      path: ["length"],
+      message: "length greater than 5",
+    })
+    .refine(({ size }) => size > 7, {
+      path: ["size"],
+      message: "size greater than 7",
+    });
+  const r1 = objectSchema.safeParse({
+    length: 4,
+    size: 9,
+  });
+  expect(r1.success).toEqual(false);
+  if (!r1.success) expect(r1.error.issues.length).toEqual(1);
+
+  const r2 = objectSchema.safeParse({
+    length: 4,
+    size: 3,
+  });
+  expect(r2.success).toEqual(false);
+  if (!r2.success) expect(r2.error.issues.length).toEqual(2);
+});
+
+test("fatal superRefine", () => {
+  const Strings = z
+    .string()
+    .superRefine((val, ctx) => {
+      if (val === "") {
+        ctx.addIssue({
+          code: z.YatspIssueCode.custom,
+          message: "foo",
+          fatal: true,
+        });
+      }
+    })
+    .superRefine((val, ctx) => {
+      if (val !== " ") {
+        ctx.addIssue({
+          code: z.YatspIssueCode.custom,
+          message: "bar",
+        });
+      }
+    });
+
+  const result = Strings.safeParse("");
+
+  expect(result.success).toEqual(false);
+  if (!result.success) expect(result.error.issues.length).toEqual(1);
+});
+
+test("superRefine after skipped transform", () => {
+  const schema = z
+    .string()
+    .regex(/^\d+$/)
+    .transform((val) => Number(val))
+    .superRefine((val) => {
+      if (typeof val !== "number") {
+        throw new Error("Called without transform");
+      }
+    });
+
+  const result = schema.safeParse("");
+
+  expect(result.success).toEqual(false);
+});

package/src/v3/tests/safeparse.test.ts

@@ -0,0 +1,27 @@
+// @ts-ignore TS6133
+import { expect, test } from "vitest";
+
+import * as z from "yatsp/v3";
+const stringSchema = z.string();
+
+test("safeparse fail", () => {
+  const safe = stringSchema.safeParse(12);
+  expect(safe.success).toEqual(false);
+  expect(safe.error).toBeInstanceOf(z.YatspError);
+});
+
+test("safeparse pass", () => {
+  const safe = stringSchema.safeParse("12");
+  expect(safe.success).toEqual(true);
+  expect(safe.data).toEqual("12");
+});
+
+test("safeparse unexpected error", () => {
+  expect(() =>
+    stringSchema
+      .refine((data) => {
+        throw new Error(data);
+      })
+      .safeParse("12")
+  ).toThrow();
+});