feat: z.string().emoji() (#2045)

* z.string().emoji() * test emojis mixed with other chars
colinhacks · Feb 16, 2023 · c244fb6 · c244fb6
1 parent e693919
commit c244fb6
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 0 deletions.
diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -91,6 +91,7 @@ export interface ZodInvalidDateIssue extends ZodIssueBase {
 export type StringValidation =
   | "email"
   | "url"
+  | "emoji"
   | "uuid"
   | "regex"
   | "cuid"

diff --git a/deno/lib/__tests__/string.test.ts b/deno/lib/__tests__/string.test.ts
@@ -129,6 +129,16 @@ test("url error overrides", () => {
   }
 });
 
+test("emoji validations", () => {
+  const emoji = z.string().emoji();
+  try {
+    emoji.parse("🍺👩‍🚀🫡");
+    emoji.parse("💚 💙 💜 💛 ❤️");
+    expect(() => emoji.parse(":-)")).toThrow();
+    expect(() => emoji.parse("😀 is an emoji")).toThrow()
+  } catch (err) {}
+});
+
 test("uuid", () => {
   const uuid = z.string().uuid("custom error");
   uuid.parse("9491d710-3185-4e06-bea0-6a2f275345e0");

diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -492,6 +492,7 @@ export type ZodStringCheck =
   | { kind: "length"; value: number; message?: string }
   | { kind: "email"; message?: string }
   | { kind: "url"; message?: string }
+  | { kind: "emoji"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
   | { kind: "cuid2"; message?: string }
@@ -526,6 +527,11 @@ const uuidRegex =
 const emailRegex =
   /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|([^-]([a-zA-Z0-9-]*\.)+[a-zA-Z]{2,}))$/;
 
+// from https://thekevinscott.com/emojis-in-javascript/#writing-a-regular-expression
+
+const emojiRegex =
+  /(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe23\u20d0-\u20f0]|\ud83c[\udffb-\udfff])?(?:\u200d(?:[^\ud800-\udfff]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe23\u20d0-\u20f0]|\ud83c[\udffb-\udfff])?)*/;
+
 // interface IsDateStringOptions extends StringDateOptions {
 /**
  * Match any configuration
@@ -653,6 +659,16 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "emoji") {
+        if (!emojiRegex.test(input.data)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            validation: "emoji",
+            code: ZodIssueCode.invalid_string,
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else if (check.kind === "uuid") {
         if (!uuidRegex.test(input.data)) {
           ctx = this._getOrReturnCtx(input, ctx);
@@ -773,6 +789,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   url(message?: errorUtil.ErrMessage) {
     return this._addCheck({ kind: "url", ...errorUtil.errToObj(message) });
   }
+  emoji(message?: errorUtil.ErrMessage) {
+    return this._addCheck({ kind: "emoji", ...errorUtil.errToObj(message) });
+  }
   uuid(message?: errorUtil.ErrMessage) {
     return this._addCheck({ kind: "uuid", ...errorUtil.errToObj(message) });
   }
@@ -879,6 +898,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   get isURL() {
     return !!this._def.checks.find((ch) => ch.kind === "url");
   }
+  get isEmoji() {
+    return !!this._def.checks.find((ch) => ch.kind === "emoji");
+  }
   get isUUID() {
     return !!this._def.checks.find((ch) => ch.kind === "uuid");
   }

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -91,6 +91,7 @@ export interface ZodInvalidDateIssue extends ZodIssueBase {
 export type StringValidation =
   | "email"
   | "url"
+  | "emoji"
   | "uuid"
   | "regex"
   | "cuid"

diff --git a/src/__tests__/string.test.ts b/src/__tests__/string.test.ts
@@ -128,6 +128,16 @@ test("url error overrides", () => {
   }
 });
 
+test("emoji validations", () => {
+  const emoji = z.string().emoji();
+  try {
+    emoji.parse("🍺👩‍🚀🫡");
+    emoji.parse("💚 💙 💜 💛 ❤️");
+    expect(() => emoji.parse(":-)")).toThrow();
+    expect(() => emoji.parse("😀 is an emoji")).toThrow()
+  } catch (err) {}
+});
+
 test("uuid", () => {
   const uuid = z.string().uuid("custom error");
   uuid.parse("9491d710-3185-4e06-bea0-6a2f275345e0");

diff --git a/src/types.ts b/src/types.ts
@@ -492,6 +492,7 @@ export type ZodStringCheck =
   | { kind: "length"; value: number; message?: string }
   | { kind: "email"; message?: string }
   | { kind: "url"; message?: string }
+  | { kind: "emoji"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
   | { kind: "cuid2"; message?: string }
@@ -526,6 +527,11 @@ const uuidRegex =
 const emailRegex =
   /^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|([^-]([a-zA-Z0-9-]*\.)+[a-zA-Z]{2,}))$/;
 
+// from https://thekevinscott.com/emojis-in-javascript/#writing-a-regular-expression
+
+const emojiRegex =
+  /(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe23\u20d0-\u20f0]|\ud83c[\udffb-\udfff])?(?:\u200d(?:[^\ud800-\udfff]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff])[\ufe0e\ufe0f]?(?:[\u0300-\u036f\ufe20-\ufe23\u20d0-\u20f0]|\ud83c[\udffb-\udfff])?)*/;
+
 // interface IsDateStringOptions extends StringDateOptions {
 /**
  * Match any configuration
@@ -653,6 +659,16 @@ export class ZodString extends ZodType<string, ZodStringDef> {
           });
           status.dirty();
         }
+      } else if (check.kind === "emoji") {
+        if (!emojiRegex.test(input.data)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            validation: "emoji",
+            code: ZodIssueCode.invalid_string,
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else if (check.kind === "uuid") {
         if (!uuidRegex.test(input.data)) {
           ctx = this._getOrReturnCtx(input, ctx);
@@ -773,6 +789,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   url(message?: errorUtil.ErrMessage) {
     return this._addCheck({ kind: "url", ...errorUtil.errToObj(message) });
   }
+  emoji(message?: errorUtil.ErrMessage) {
+    return this._addCheck({ kind: "emoji", ...errorUtil.errToObj(message) });
+  }
   uuid(message?: errorUtil.ErrMessage) {
     return this._addCheck({ kind: "uuid", ...errorUtil.errToObj(message) });
   }
@@ -879,6 +898,9 @@ export class ZodString extends ZodType<string, ZodStringDef> {
   get isURL() {
     return !!this._def.checks.find((ch) => ch.kind === "url");
   }
+  get isEmoji() {
+    return !!this._def.checks.find((ch) => ch.kind === "emoji");
+  }
   get isUUID() {
     return !!this._def.checks.find((ch) => ch.kind === "uuid");
   }