Add invalid_literal issue

colinhacks · Mar 27, 2022 · 823dda9 · 823dda9
1 parent baf9b53
commit 823dda9
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 10 deletions.
diff --git a/deno/lib/ZodError.ts b/deno/lib/ZodError.ts
@@ -4,6 +4,7 @@ import { util } from "./helpers/util.ts";
 
 export const ZodIssueCode = util.arrayToEnum([
   "invalid_type",
+  "invalid_literal",
   "custom",
   "invalid_union",
   "invalid_union_discriminator",
@@ -23,7 +24,6 @@ export type ZodIssueCode = keyof typeof ZodIssueCode;
 
 export type ZodIssueBase = {
   path: (string | number)[];
-  // code: ZodIssueCode;
   message?: string;
 };
 
@@ -33,6 +33,11 @@ export interface ZodInvalidTypeIssue extends ZodIssueBase {
   received: ZodParsedType;
 }
 
+export interface ZodInvalidLiteralIssue extends ZodIssueBase {
+  code: typeof ZodIssueCode.invalid_literal;
+  expected: unknown;
+}
+
 export interface ZodUnrecognizedKeysIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.unrecognized_keys;
   keys: string[];
@@ -106,6 +111,7 @@ export type DenormalizedError = { [k: string]: DenormalizedError | string[] };
 
 export type ZodIssueOptionalMessage =
   | ZodInvalidTypeIssue
+  | ZodInvalidLiteralIssue
   | ZodUnrecognizedKeysIssue
   | ZodInvalidUnionIssue
   | ZodInvalidUnionDiscriminatorIssue
@@ -286,6 +292,11 @@ export const defaultErrorMap = (
         message = `Expected ${issue.expected}, received ${issue.received}`;
       }
       break;
+    case ZodIssueCode.invalid_literal:
+      message = `Invalid literal value, expected ${JSON.stringify(
+        issue.expected
+      )}`;
+      break;
     case ZodIssueCode.unrecognized_keys:
       message = `Unrecognized key(s) in object: ${issue.keys
         .map((k) => `'${k}'`)

diff --git a/deno/lib/__tests__/error.test.ts b/deno/lib/__tests__/error.test.ts
@@ -419,7 +419,9 @@ test("literal default error message", () => {
   } catch (err) {
     const zerr: z.ZodError = err as any;
     expect(zerr.issues.length).toEqual(1);
-    expect(zerr.issues[0].message).toEqual("Expected string, received string");
+    expect(zerr.issues[0].message).toEqual(
+      `Invalid literal value, expected "Tuna"`
+    );
   }
 });
 

diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -2987,9 +2987,8 @@ export class ZodLiteral<T> extends ZodType<T, ZodLiteralDef<T>> {
     if (input.data !== this._def.value) {
       const ctx = this._getOrReturnCtx(input);
       addIssueToContext(ctx, {
-        code: ZodIssueCode.invalid_type,
-        expected: getParsedType(this._def.value),
-        received: ctx.parsedType,
+        code: ZodIssueCode.invalid_literal,
+        expected: this._def.value,
       });
       return INVALID;
     }

diff --git a/src/ZodError.ts b/src/ZodError.ts
@@ -4,6 +4,7 @@ import { util } from "./helpers/util";
 
 export const ZodIssueCode = util.arrayToEnum([
   "invalid_type",
+  "invalid_literal",
   "custom",
   "invalid_union",
   "invalid_union_discriminator",
@@ -23,7 +24,6 @@ export type ZodIssueCode = keyof typeof ZodIssueCode;
 
 export type ZodIssueBase = {
   path: (string | number)[];
-  // code: ZodIssueCode;
   message?: string;
 };
 
@@ -33,6 +33,11 @@ export interface ZodInvalidTypeIssue extends ZodIssueBase {
   received: ZodParsedType;
 }
 
+export interface ZodInvalidLiteralIssue extends ZodIssueBase {
+  code: typeof ZodIssueCode.invalid_literal;
+  expected: unknown;
+}
+
 export interface ZodUnrecognizedKeysIssue extends ZodIssueBase {
   code: typeof ZodIssueCode.unrecognized_keys;
   keys: string[];
@@ -106,6 +111,7 @@ export type DenormalizedError = { [k: string]: DenormalizedError | string[] };
 
 export type ZodIssueOptionalMessage =
   | ZodInvalidTypeIssue
+  | ZodInvalidLiteralIssue
   | ZodUnrecognizedKeysIssue
   | ZodInvalidUnionIssue
   | ZodInvalidUnionDiscriminatorIssue
@@ -286,6 +292,11 @@ export const defaultErrorMap = (
         message = `Expected ${issue.expected}, received ${issue.received}`;
       }
       break;
+    case ZodIssueCode.invalid_literal:
+      message = `Invalid literal value, expected ${JSON.stringify(
+        issue.expected
+      )}`;
+      break;
     case ZodIssueCode.unrecognized_keys:
       message = `Unrecognized key(s) in object: ${issue.keys
         .map((k) => `'${k}'`)

diff --git a/src/__tests__/error.test.ts b/src/__tests__/error.test.ts
@@ -418,7 +418,9 @@ test("literal default error message", () => {
   } catch (err) {
     const zerr: z.ZodError = err as any;
     expect(zerr.issues.length).toEqual(1);
-    expect(zerr.issues[0].message).toEqual("Expected string, received string");
+    expect(zerr.issues[0].message).toEqual(
+      `Invalid literal value, expected "Tuna"`
+    );
   }
 });
 

diff --git a/src/types.ts b/src/types.ts
@@ -2987,9 +2987,8 @@ export class ZodLiteral<T> extends ZodType<T, ZodLiteralDef<T>> {
     if (input.data !== this._def.value) {
       const ctx = this._getOrReturnCtx(input);
       addIssueToContext(ctx, {
-        code: ZodIssueCode.invalid_type,
-        expected: getParsedType(this._def.value),
-        received: ctx.parsedType,
+        code: ZodIssueCode.invalid_literal,
+        expected: this._def.value,
       });
       return INVALID;
     }