feat: z.string().ulid() - add support for ulids (#2049)

* feat: add support for ulids * chore: update docs * chore: cleanup
colinhacks · Mar 6, 2023 · 64883e4 · 64883e4
1 parent 728e56a
commit 64883e4
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -650,6 +650,7 @@ z.string().emoji();
 z.string().uuid();
 z.string().cuid();
 z.string().cuid2();
+z.string().ulid();
 z.string().regex(regex);
 z.string().includes(string);
 z.string().startsWith(string);

diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -96,6 +96,7 @@ export type StringValidation =
   | "regex"
   | "cuid"
   | "cuid2"
+  | "ulid"
   | "datetime"
   | "ip"
   | { includes: string; position?: number }

diff --git a/deno/lib/__tests__/string.test.ts b/deno/lib/__tests__/string.test.ts
@@ -223,6 +223,16 @@ test("cuid2", () => {
   }
 });
 
+test("ulid", () => {
+  const cuid = z.string().cuid();
+  cuid.parse("01ARZ3NDEKTSV4RRFFQ69G5FAV");
+  const result = cuid.safeParse("invalidulid");
+  expect(result.success).toEqual(false);
+  if (!result.success) {
+    expect(result.error.issues[0].message).toEqual("Invalid ulid");
+  }
+});
+
 test("regex", () => {
   z.string()
     .regex(/^moo+$/)

diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -515,6 +515,7 @@ export type ZodStringCheck =
   | { kind: "cuid"; message?: string }
   | { kind: "includes"; value: string; position?: number; message?: string }
   | { kind: "cuid2"; message?: string }
+  | { kind: "ulid"; message?: string }
   | { kind: "startsWith"; value: string; message?: string }
   | { kind: "endsWith"; value: string; message?: string }
   | { kind: "regex"; regex: RegExp; message?: string }
@@ -537,6 +538,7 @@ export interface ZodStringDef extends ZodTypeDef {
 
 const cuidRegex = /^c[^\s-]{8,}$/i;
 const cuid2Regex = /^[a-z][a-z0-9]*$/;
+const ulidRegex = /[0-9A-HJKMNP-TV-Z]{26}/;
 const uuidRegex =
   /^([a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[a-f0-9]{4}-[a-f0-9]{12}|00000000-0000-0000-0000-000000000000)$/i;
 // from https://stackoverflow.com/a/46181/1550155
@@ -728,6 +730,16 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "ulid") {
+        if (!ulidRegex.test(input.data)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            validation: "ulid",
+            code: ZodIssueCode.invalid_string,
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else if (check.kind === "url") {
         try {
           new URL(input.data);
@@ -855,10 +867,14 @@ export class ZodString extends ZodType<string, ZodStringDef> {
     return this._addCheck({ kind: "cuid2", ...errorUtil.errToObj(message) });
   }
 
+  ulid(message?: errorUtil.ErrMessage) {
+    return this._addCheck({ kind: "ulid", ...errorUtil.errToObj(message) });
+  }
+
   ip(options?: string | { version?: "v4" | "v6"; message?: string }) {
     return this._addCheck({ kind: "ip", ...errorUtil.errToObj(options) });
   }
-
+  
   datetime(
     options?:
       | string
@@ -989,6 +1005,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   get isCUID2() {
     return !!this._def.checks.find((ch) => ch.kind === "cuid2");
   }
+  get isULID() {
+    return !!this._def.checks.find((ch) => ch.kind === "ulid");
+  }
   get isIP() {
     return !!this._def.checks.find((ch) => ch.kind === "ip");
   }

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -96,6 +96,7 @@ export type StringValidation =
   | "regex"
   | "cuid"
   | "cuid2"
+  | "ulid"
   | "datetime"
   | "ip"
   | { includes: string; position?: number }

diff --git a/src/__tests__/string.test.ts b/src/__tests__/string.test.ts
@@ -222,6 +222,16 @@ test("cuid2", () => {
   }
 });
 
+test("ulid", () => {
+  const cuid = z.string().cuid();
+  cuid.parse("01ARZ3NDEKTSV4RRFFQ69G5FAV");
+  const result = cuid.safeParse("invalidulid");
+  expect(result.success).toEqual(false);
+  if (!result.success) {
+    expect(result.error.issues[0].message).toEqual("Invalid ulid");
+  }
+});
+
 test("regex", () => {
   z.string()
     .regex(/^moo+$/)

diff --git a/src/types.ts b/src/types.ts
@@ -515,6 +515,7 @@ export type ZodStringCheck =
   | { kind: "cuid"; message?: string }
   | { kind: "includes"; value: string; position?: number; message?: string }
   | { kind: "cuid2"; message?: string }
+  | { kind: "ulid"; message?: string }
   | { kind: "startsWith"; value: string; message?: string }
   | { kind: "endsWith"; value: string; message?: string }
   | { kind: "regex"; regex: RegExp; message?: string }
@@ -537,6 +538,7 @@ export interface ZodStringDef extends ZodTypeDef {
 
 const cuidRegex = /^c[^\s-]{8,}$/i;
 const cuid2Regex = /^[a-z][a-z0-9]*$/;
+const ulidRegex = /[0-9A-HJKMNP-TV-Z]{26}/;
 const uuidRegex =
   /^([a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[a-f0-9]{4}-[a-f0-9]{12}|00000000-0000-0000-0000-000000000000)$/i;
 // from https://stackoverflow.com/a/46181/1550155
@@ -728,6 +730,16 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "ulid") {
+        if (!ulidRegex.test(input.data)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            validation: "ulid",
+            code: ZodIssueCode.invalid_string,
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else if (check.kind === "url") {
         try {
           new URL(input.data);
@@ -854,6 +866,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   cuid2(message?: errorUtil.ErrMessage) {
     return this._addCheck({ kind: "cuid2", ...errorUtil.errToObj(message) });
   }
+  ulid(message?: errorUtil.ErrMessage) {
+    return this._addCheck({ kind: "ulid", ...errorUtil.errToObj(message) });
+  }
 
   ip(options?: string | { version?: "v4" | "v6"; message?: string }) {
     return this._addCheck({ kind: "ip", ...errorUtil.errToObj(options) });
@@ -989,6 +1004,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   get isCUID2() {
     return !!this._def.checks.find((ch) => ch.kind === "cuid2");
   }
+  get isULID() {
+    return !!this._def.checks.find((ch) => ch.kind === "ulid");
+  }
   get isIP() {
     return !!this._def.checks.find((ch) => ch.kind === "ip");
   }