add localized bool schema support

colinhacks · Apr 27, 2022 · 8688e9f · 8688e9f
1 parent f6981f8
commit 8688e9f
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -94,6 +94,8 @@ These docs have been translated into [Chinese](./README_ZH.md).
   - [.promise](#promise)
   - [.or](#or)
   - [.and](#and)
+  - [.describe](#describe)
+  - [.localize](#localize)
 - [Guides and concepts](#guides-and-concepts)
   - [Type inference](#type-inference)
   - [Writing generic functions](#writing-generic-functions)
@@ -1694,6 +1696,22 @@ const nullishString = z.string().nullish(); // string | null | undefined
 z.string().optional().nullable();
 ```
 
+### `.localize`
+
+A schema method that defines that the schema should be translated.
+
+```ts
+const isLocalized = z.string().localize(true).localized; // boolean
+```
+
+### `.describe`
+
+A schema method that adds a description to the schema for documentation purpose.
+
+```ts
+const description = z.string().describe('usefull description').description; // string
+```
+
 ### `.array`
 
 A convenience method that returns an array schema for the given type:

diff --git a/deno/lib/__tests__/localize.test.ts b/deno/lib/__tests__/localize.test.ts
@@ -0,0 +1,11 @@
+// @ts-ignore TS6133
+import { expect } from "https://deno.land/x/expect@v0.2.6/mod.ts";
+const test = Deno.test;
+
+import * as z from "../index.ts";
+
+test("localize", () => {
+  const localized = true;
+  const schema = z.string().localize(localized);
+  expect(schema.localized).toEqual(localized);
+});
diff --git a/deno/lib/types.ts b/deno/lib/types.ts
@@ -58,6 +58,7 @@ export type CustomErrorParams = Partial<util.Omit<ZodCustomIssue, "code">>;
 export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
   description?: string;
+  localized?: boolean;
 }
 
 class ParseInputLazyPath implements ParseInput {
@@ -104,12 +105,23 @@ type RawCreateParams =
       invalid_type_error?: string;
       required_error?: string;
       description?: string;
+      localized?: boolean;
     }
   | undefined;
-type ProcessedCreateParams = { errorMap?: ZodErrorMap; description?: string };
+type ProcessedCreateParams = {
+  errorMap?: ZodErrorMap;
+  description?: string;
+  localized?: boolean;
+};
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
-  const { errorMap, invalid_type_error, required_error, description } = params;
+  const {
+    errorMap,
+    invalid_type_error,
+    required_error,
+    description,
+    localized,
+  } = params;
   if (errorMap && (invalid_type_error || required_error)) {
     throw new Error(
       `Can't use "invalid" or "required" in conjunction with custom error map.`
@@ -124,7 +136,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
       return { message: params.invalid_type_error };
     return { message: ctx.defaultError };
   };
-  return { errorMap: customMap, description };
+  return { errorMap: customMap, description, localized };
 }
 
 export type SafeParseSuccess<Output> = { success: true; data: Output };
@@ -148,6 +160,10 @@ export abstract class ZodType<
     return this._def.description;
   }
 
+  get localized() {
+    return this._def.localized;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _getType(input: ParseInput): string {
@@ -374,6 +390,7 @@ export abstract class ZodType<
     this.describe = this.describe.bind(this);
     this.isNullable = this.isNullable.bind(this);
     this.isOptional = this.isOptional.bind(this);
+    this.localize = this.localize.bind(this);
   }
 
   optional(): ZodOptional<this> {
@@ -430,6 +447,14 @@ export abstract class ZodType<
     });
   }
 
+  localize(localized: boolean): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      localized,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }

diff --git a/src/__tests__/localize.test.ts b/src/__tests__/localize.test.ts
@@ -0,0 +1,10 @@
+// @ts-ignore TS6133
+import { expect, test } from "@jest/globals";
+
+import * as z from "../index";
+
+test("localize", () => {
+  const localized = true;
+  const schema = z.string().localize(localized);
+  expect(schema.localized).toEqual(localized);
+});
diff --git a/src/types.ts b/src/types.ts
@@ -58,6 +58,7 @@ export type CustomErrorParams = Partial<util.Omit<ZodCustomIssue, "code">>;
 export interface ZodTypeDef {
   errorMap?: ZodErrorMap;
   description?: string;
+  localized?: boolean;
 }
 
 class ParseInputLazyPath implements ParseInput {
@@ -104,12 +105,23 @@ type RawCreateParams =
       invalid_type_error?: string;
       required_error?: string;
       description?: string;
+      localized?: boolean;
     }
   | undefined;
-type ProcessedCreateParams = { errorMap?: ZodErrorMap; description?: string };
+type ProcessedCreateParams = {
+  errorMap?: ZodErrorMap;
+  description?: string;
+  localized?: boolean;
+};
 function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
   if (!params) return {};
-  const { errorMap, invalid_type_error, required_error, description } = params;
+  const {
+    errorMap,
+    invalid_type_error,
+    required_error,
+    description,
+    localized,
+  } = params;
   if (errorMap && (invalid_type_error || required_error)) {
     throw new Error(
       `Can't use "invalid" or "required" in conjunction with custom error map.`
@@ -124,7 +136,7 @@ function processCreateParams(params: RawCreateParams): ProcessedCreateParams {
       return { message: params.invalid_type_error };
     return { message: ctx.defaultError };
   };
-  return { errorMap: customMap, description };
+  return { errorMap: customMap, description, localized };
 }
 
 export type SafeParseSuccess<Output> = { success: true; data: Output };
@@ -148,6 +160,10 @@ export abstract class ZodType<
     return this._def.description;
   }
 
+  get localized() {
+    return this._def.localized;
+  }
+
   abstract _parse(input: ParseInput): ParseReturnType<Output>;
 
   _getType(input: ParseInput): string {
@@ -374,6 +390,7 @@ export abstract class ZodType<
     this.describe = this.describe.bind(this);
     this.isNullable = this.isNullable.bind(this);
     this.isOptional = this.isOptional.bind(this);
+    this.localize = this.localize.bind(this);
   }
 
   optional(): ZodOptional<this> {
@@ -430,6 +447,14 @@ export abstract class ZodType<
     });
   }
 
+  localize(localized: boolean): this {
+    const This = (this as any).constructor;
+    return new This({
+      ...this._def,
+      localized,
+    });
+  }
+
   isOptional(): boolean {
     return this.safeParse(undefined).success;
   }