Add string.startsWith and string.endsWith (#1235)

* Add string.startsWith and string.endsWith * Update implementation of startsWith and endsWith * Update readmes Co-authored-by: Colin McDonnell <colinmcd@alum.mit.edu>
colinhacks · Jul 18, 2022 · 799fbb1 · 799fbb1
1 parent ff43b2e
commit 799fbb1
Show file tree

Hide file tree

Showing 9 changed files with 146 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -453,6 +453,8 @@ z.string().url();
 z.string().uuid();
 z.string().cuid();
 z.string().regex(regex);
+z.string().startsWith(string);
+z.string().endsWith(string);
 
 // trim whitespace
 z.string().trim();
@@ -484,6 +486,8 @@ z.string().length(5, { message: "Must be exactly 5 characters long" });
 z.string().email({ message: "Invalid email address" });
 z.string().url({ message: "Invalid url" });
 z.string().uuid({ message: "Invalid UUID" });
+z.string().startsWith("https://", { message: "Must provide secure URL" });
+z.string().endsWith(".com", { message: "Only .com domains allowed" });
 ```
 
 ## Numbers

diff --git a/README_ZH.md b/README_ZH.md
@@ -391,6 +391,8 @@ z.string().email();
 z.string().url();
 z.string().uuid();
 z.string().regex(regex);
+z.string().startsWith(string);
+z.string().endsWith(string);
 
 // 已废弃，等同于 .min(1)
 z.string().nonempty();
@@ -409,6 +411,8 @@ z.string().length(5, { message: "Must be exactly 5 characters long" });
 z.string().email({ message: "Invalid email address." });
 z.string().url({ message: "Invalid url" });
 z.string().uuid({ message: "Invalid UUID" });
+z.string().startsWith("https://", { message: "Must provide secure URL" });
+z.string().endsWith(".com", { message: "Only .com domains allowed" });
 ```
 
 ## Numbers
@@ -555,9 +559,9 @@ const user = z.object({
 
 const deepPartialUser = user.deepPartial();
 
-/* 
+/*
 {
-  username?: string | undefined, 
+  username?: string | undefined,
   location?: {
     latitude?: number | undefined;
     longitude?: number | undefined;
@@ -884,12 +888,12 @@ const FishEnum = z.enum(fish);
 FishEnum.enum.Salmon; // => 自动补全
 
 FishEnum.enum;
-/* 
+/*
 => {
   Salmon: "Salmon",
   Tuna: "Tuna",
   Trout: "Trout",
-} 
+}
 */
 ```
 

diff --git a/deno/lib/README.md b/deno/lib/README.md
@@ -453,6 +453,8 @@ z.string().url();
 z.string().uuid();
 z.string().cuid();
 z.string().regex(regex);
+z.string().startsWith(string);
+z.string().endsWith(string);
 
 // trim whitespace
 z.string().trim();
@@ -484,6 +486,8 @@ z.string().length(5, { message: "Must be exactly 5 characters long" });
 z.string().email({ message: "Invalid email address" });
 z.string().url({ message: "Invalid url" });
 z.string().uuid({ message: "Invalid UUID" });
+z.string().startsWith("https://", { message: "Must provide secure URL" });
+z.string().endsWith(".com", { message: "Only .com domains allowed" });
 ```
 
 ## Numbers

diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -86,7 +86,14 @@ export interface ZodInvalidDateIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.invalid_date;
 }
 
-export type StringValidation = "email" | "url" | "uuid" | "regex" | "cuid";
+export type StringValidation =
+  | "email"
+  | "url"
+  | "uuid"
+  | "regex"
+  | "cuid"
+  | { startsWith: string }
+  | { endsWith: string };
 
 export interface ZodInvalidStringIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.invalid_string;
@@ -344,8 +351,19 @@ export const defaultErrorMap = (
       message = `Invalid date`;
       break;
     case ZodIssueCode.invalid_string:
-      if (issue.validation !== "regex") message = `Invalid ${issue.validation}`;
-      else message = "Invalid";
+      if (typeof issue.validation === "object") {
+        if ("startsWith" in issue.validation) {
+          message = `Invalid input: must start with "${issue.validation.startsWith}"`;
+        } else if ("endsWith" in issue.validation) {
+          message = `Invalid input: must start with "${issue.validation.endsWith}"`;
+        } else {
+          util.assertNever(issue.validation);
+        }
+      } else if (issue.validation !== "regex") {
+        message = `Invalid ${issue.validation}`;
+      } else {
+        message = "Invalid";
+      }
       break;
     case ZodIssueCode.too_small:
       if (issue.type === "array")

diff --git a/deno/lib/__tests__/string.test.ts b/deno/lib/__tests__/string.test.ts
@@ -8,6 +8,8 @@ const minFive = z.string().min(5, "min5");
 const maxFive = z.string().max(5, "max5");
 const justFive = z.string().length(5);
 const nonempty = z.string().nonempty("nonempty");
+const startsWith = z.string().startsWith("startsWith");
+const endsWith = z.string().endsWith("endsWith");
 
 test("passing validations", () => {
   minFive.parse("12345");
@@ -16,6 +18,8 @@ test("passing validations", () => {
   maxFive.parse("1234");
   nonempty.parse("1");
   justFive.parse("12345");
+  startsWith.parse("startsWithX");
+  endsWith.parse("XendsWith");
 });
 
 test("failing validations", () => {
@@ -24,6 +28,8 @@ test("failing validations", () => {
   expect(() => nonempty.parse("")).toThrow();
   expect(() => justFive.parse("1234")).toThrow();
   expect(() => justFive.parse("123456")).toThrow();
+  expect(() => startsWith.parse("x")).toThrow();
+  expect(() => endsWith.parse("x")).toThrow();
 });
 
 test("email validations", () => {

diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -450,6 +450,8 @@ type ZodStringCheck =
   | { kind: "url"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
+  | { kind: "startsWith"; value: string; message?: string }
+  | { kind: "endsWith"; value: string; message?: string }
   | { kind: "regex"; regex: RegExp; message?: string }
   | { kind: "trim"; message?: string };
 
@@ -570,6 +572,26 @@ export class ZodString extends ZodType<string, ZodStringDef> {
         }
       } else if (check.kind === "trim") {
         input.data = input.data.trim();
+      } else if (check.kind === "startsWith") {
+        if (!(input.data as string).startsWith(check.value)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            code: ZodIssueCode.invalid_string,
+            validation: { startsWith: check.value },
+            message: check.message,
+          });
+          status.dirty();
+        }
+      } else if (check.kind === "endsWith") {
+        if (!(input.data as string).endsWith(check.value)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            code: ZodIssueCode.invalid_string,
+            validation: { endsWith: check.value },
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else {
         util.assertNever(check);
       }
@@ -616,6 +638,22 @@ export class ZodString extends ZodType<string, ZodStringDef> {
     });
   }
 
+  startsWith(value: string, message?: errorUtil.ErrMessage) {
+    return this._addCheck({
+      kind: "startsWith",
+      value: value,
+      ...errorUtil.errToObj(message),
+    });
+  }
+
+  endsWith(value: string, message?: errorUtil.ErrMessage) {
+    return this._addCheck({
+      kind: "endsWith",
+      value: value,
+      ...errorUtil.errToObj(message),
+    });
+  }
+
   min(minLength: number, message?: errorUtil.ErrMessage) {
     return this._addCheck({
       kind: "min",

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -86,7 +86,14 @@ export interface ZodInvalidDateIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.invalid_date;
 }
 
-export type StringValidation = "email" | "url" | "uuid" | "regex" | "cuid";
+export type StringValidation =
+  | "email"
+  | "url"
+  | "uuid"
+  | "regex"
+  | "cuid"
+  | { startsWith: string }
+  | { endsWith: string };
 
 export interface ZodInvalidStringIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.invalid_string;
@@ -344,8 +351,19 @@ export const defaultErrorMap = (
       message = `Invalid date`;
       break;
     case ZodIssueCode.invalid_string:
-      if (issue.validation !== "regex") message = `Invalid ${issue.validation}`;
-      else message = "Invalid";
+      if (typeof issue.validation === "object") {
+        if ("startsWith" in issue.validation) {
+          message = `Invalid input: must start with "${issue.validation.startsWith}"`;
+        } else if ("endsWith" in issue.validation) {
+          message = `Invalid input: must start with "${issue.validation.endsWith}"`;
+        } else {
+          util.assertNever(issue.validation);
+        }
+      } else if (issue.validation !== "regex") {
+        message = `Invalid ${issue.validation}`;
+      } else {
+        message = "Invalid";
+      }
       break;
     case ZodIssueCode.too_small:
       if (issue.type === "array")

diff --git a/src/__tests__/string.test.ts b/src/__tests__/string.test.ts
@@ -7,6 +7,8 @@ const minFive = z.string().min(5, "min5");
 const maxFive = z.string().max(5, "max5");
 const justFive = z.string().length(5);
 const nonempty = z.string().nonempty("nonempty");
+const startsWith = z.string().startsWith("startsWith");
+const endsWith = z.string().endsWith("endsWith");
 
 test("passing validations", () => {
   minFive.parse("12345");
@@ -15,6 +17,8 @@ test("passing validations", () => {
   maxFive.parse("1234");
   nonempty.parse("1");
   justFive.parse("12345");
+  startsWith.parse("startsWithX");
+  endsWith.parse("XendsWith");
 });
 
 test("failing validations", () => {
@@ -23,6 +27,8 @@ test("failing validations", () => {
   expect(() => nonempty.parse("")).toThrow();
   expect(() => justFive.parse("1234")).toThrow();
   expect(() => justFive.parse("123456")).toThrow();
+  expect(() => startsWith.parse("x")).toThrow();
+  expect(() => endsWith.parse("x")).toThrow();
 });
 
 test("email validations", () => {

diff --git a/src/types.ts b/src/types.ts
@@ -450,6 +450,8 @@ type ZodStringCheck =
   | { kind: "url"; message?: string }
   | { kind: "uuid"; message?: string }
   | { kind: "cuid"; message?: string }
+  | { kind: "startsWith"; value: string; message?: string }
+  | { kind: "endsWith"; value: string; message?: string }
   | { kind: "regex"; regex: RegExp; message?: string }
   | { kind: "trim"; message?: string };
 
@@ -570,6 +572,26 @@ export class ZodString extends ZodType<string, ZodStringDef> {
         }
       } else if (check.kind === "trim") {
         input.data = input.data.trim();
+      } else if (check.kind === "startsWith") {
+        if (!(input.data as string).startsWith(check.value)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            code: ZodIssueCode.invalid_string,
+            validation: { startsWith: check.value },
+            message: check.message,
+          });
+          status.dirty();
+        }
+      } else if (check.kind === "endsWith") {
+        if (!(input.data as string).endsWith(check.value)) {
+          ctx = this._getOrReturnCtx(input, ctx);
+          addIssueToContext(ctx, {
+            code: ZodIssueCode.invalid_string,
+            validation: { endsWith: check.value },
+            message: check.message,
+          });
+          status.dirty();
+        }
       } else {
         util.assertNever(check);
       }
@@ -616,6 +638,22 @@ export class ZodString extends ZodType<string, ZodStringDef> {
     });
   }
 
+  startsWith(value: string, message?: errorUtil.ErrMessage) {
+    return this._addCheck({
+      kind: "startsWith",
+      value: value,
+      ...errorUtil.errToObj(message),
+    });
+  }
+
+  endsWith(value: string, message?: errorUtil.ErrMessage) {
+    return this._addCheck({
+      kind: "endsWith",
+      value: value,
+      ...errorUtil.errToObj(message),
+    });
+  }
+
   min(minLength: number, message?: errorUtil.ErrMessage) {
     return this._addCheck({
       kind: "min",