zod 4.3.0-canary.20251216T172808 → 4.3.0-canary.20251222T195342

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod",
-  "version": "4.3.0-canary.20251216T172808",
+  "version": "4.3.0-canary.20251222T195342",
   "type": "module",
   "license": "MIT",
   "author": "Colin McDonnell <zod@colinhacks.com>",

package/src/v4/classic/schemas.ts

@@ -48,7 +48,9 @@ export interface ZodType<
       : ["Incompatible schema"]
   ): this;
 
-  brand<T extends PropertyKey = PropertyKey>(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T>;
+  brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(
+    value?: T
+  ): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
 
   // parsing
   parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>;
@@ -253,7 +255,7 @@ export interface _ZodString<T extends core.$ZodStringInternals<unknown> = core.$
 
   // miscellaneous checks
   regex(regex: RegExp, params?: string | core.$ZodCheckRegexParams): this;
-  includes(value: string, params?: core.$ZodCheckIncludesParams): this;
+  includes(value: string, params?: string | core.$ZodCheckIncludesParams): this;
   startsWith(value: string, params?: string | core.$ZodCheckStartsWithParams): this;
   endsWith(value: string, params?: string | core.$ZodCheckEndsWithParams): this;
   min(minLength: number, params?: string | core.$ZodCheckMinLengthParams): this;

package/src/v4/classic/tests/brand.test.ts

@@ -61,3 +61,46 @@ test("branded record", () => {
   type recordWithBrandedNumberKeys = z.infer<typeof recordWithBrandedNumberKeys>;
   expectTypeOf<recordWithBrandedNumberKeys>().toEqualTypeOf<Record<string & z.core.$brand<"SomeBrand">, number>>();
 });
+
+test("brand direction: out (default)", () => {
+  const schema = z.string().brand<"A">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // output is branded
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+  // input is NOT branded (default behavior)
+  expectTypeOf<Input>().toEqualTypeOf<string>();
+});
+
+test("brand direction: out (explicit)", () => {
+  const schema = z.string().brand<"A", "out">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // output is branded
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+  // input is NOT branded
+  expectTypeOf<Input>().toEqualTypeOf<string>();
+});
+
+test("brand direction: in", () => {
+  const schema = z.string().brand<"A", "in">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // input is branded
+  expectTypeOf<Input>().toEqualTypeOf<string & z.$brand<"A">>();
+  // output is NOT branded
+  expectTypeOf<Output>().toEqualTypeOf<string>();
+});
+
+test("brand direction: inout", () => {
+  const schema = z.string().brand<"A", "inout">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // both are branded
+  expectTypeOf<Input>().toEqualTypeOf<string & z.$brand<"A">>();
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+});

package/src/v4/classic/tests/string.test.ts

@@ -35,6 +35,27 @@ test("includes", () => {
   expect(() => includesFromIndex2.parse("XincludesXX")).toThrow();
 });
 
+test("includes with string error message", () => {
+  const schema = z.string().includes("test", "must contain test");
+  schema.parse("this is a test");
+
+  expect(schema.safeParse("this is invalid")).toMatchInlineSnapshot(`
+    {
+      "error": [ZodError: [
+      {
+        "origin": "string",
+        "code": "invalid_format",
+        "format": "includes",
+        "includes": "test",
+        "path": [],
+        "message": "must contain test"
+      }
+    ]],
+      "success": false,
+    }
+  `);
+});
+
 test("startswith/endswith", () => {
   startsWith.parse("startsWithX");
   endsWith.parse("XendsWith");

package/src/v4/core/core.ts

@@ -82,8 +82,16 @@ export type $brand<T extends string | number | symbol = string | number | symbol
   [$brand]: { [k in T]: true };
 };
 
-export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol> = T &
-  Record<"_zod", Record<"output", output<T> & $brand<Brand>>>;
+export type $ZodBranded<
+  T extends schemas.SomeType,
+  Brand extends string | number | symbol,
+  Dir extends "in" | "out" | "inout" = "out",
+> = T &
+  (Dir extends "inout"
+    ? { _zod: { input: input<T> & $brand<Brand>; output: output<T> & $brand<Brand> } }
+    : Dir extends "in"
+      ? { _zod: { input: input<T> & $brand<Brand> } }
+      : { _zod: { output: output<T> & $brand<Brand> } });
 
 export class $ZodAsyncError extends Error {
   constructor() {

package/src/v4/mini/schemas.ts

@@ -20,9 +20,9 @@ export interface ZodMiniType<
         : [core.$replace<R["_meta"], this>]
       : ["Incompatible schema"]
   ): this;
-  brand<T extends PropertyKey = PropertyKey>(
+  brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(
     value?: T
-  ): PropertyKey extends T ? this : this & Record<"_zod", Record<"output", core.output<this> & core.$brand<T>>>;
+  ): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
 
   def: Internals["def"];
 

package/src/v4/mini/tests/brand.test.ts

@@ -49,3 +49,46 @@ test("branded types", () => {
   // @ts-expect-error
   doStuff({ name: "hello there!" });
 });
+
+test("brand direction: out (default)", () => {
+  const schema = z.string().brand<"A">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // output is branded
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+  // input is NOT branded (default behavior)
+  expectTypeOf<Input>().toEqualTypeOf<string>();
+});
+
+test("brand direction: out (explicit)", () => {
+  const schema = z.string().brand<"A", "out">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // output is branded
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+  // input is NOT branded
+  expectTypeOf<Input>().toEqualTypeOf<string>();
+});
+
+test("brand direction: in", () => {
+  const schema = z.string().brand<"A", "in">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // input is branded
+  expectTypeOf<Input>().toEqualTypeOf<string & z.$brand<"A">>();
+  // output is NOT branded
+  expectTypeOf<Output>().toEqualTypeOf<string>();
+});
+
+test("brand direction: inout", () => {
+  const schema = z.string().brand<"A", "inout">();
+  type Input = z.input<typeof schema>;
+  type Output = z.output<typeof schema>;
+
+  // both are branded
+  expectTypeOf<Input>().toEqualTypeOf<string & z.$brand<"A">>();
+  expectTypeOf<Output>().toEqualTypeOf<string & z.$brand<"A">>();
+});

package/v4/classic/schemas.d.cts

@@ -20,7 +20,7 @@ export interface ZodType<out Output = unknown, out Input = unknown, out Internal
         parent: boolean;
     }): this;
     register<R extends core.$ZodRegistry>(registry: R, ...meta: this extends R["_schema"] ? undefined extends R["_meta"] ? [core.$replace<R["_meta"], this>?] : [core.$replace<R["_meta"], this>] : ["Incompatible schema"]): this;
-    brand<T extends PropertyKey = PropertyKey>(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T>;
+    brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
     parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>;
     safeParse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): parse.ZodSafeParseResult<core.output<this>>;
     parseAsync(data: unknown, params?: core.ParseContext<core.$ZodIssue>): Promise<core.output<this>>;
@@ -86,7 +86,7 @@ export interface _ZodString<T extends core.$ZodStringInternals<unknown> = core.$
     minLength: number | null;
     maxLength: number | null;
     regex(regex: RegExp, params?: string | core.$ZodCheckRegexParams): this;
-    includes(value: string, params?: core.$ZodCheckIncludesParams): this;
+    includes(value: string, params?: string | core.$ZodCheckIncludesParams): this;
     startsWith(value: string, params?: string | core.$ZodCheckStartsWithParams): this;
     endsWith(value: string, params?: string | core.$ZodCheckEndsWithParams): this;
     min(minLength: number, params?: string | core.$ZodCheckMinLengthParams): this;

package/v4/classic/schemas.d.ts

@@ -20,7 +20,7 @@ export interface ZodType<out Output = unknown, out Input = unknown, out Internal
         parent: boolean;
     }): this;
     register<R extends core.$ZodRegistry>(registry: R, ...meta: this extends R["_schema"] ? undefined extends R["_meta"] ? [core.$replace<R["_meta"], this>?] : [core.$replace<R["_meta"], this>] : ["Incompatible schema"]): this;
-    brand<T extends PropertyKey = PropertyKey>(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T>;
+    brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
     parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>;
     safeParse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): parse.ZodSafeParseResult<core.output<this>>;
     parseAsync(data: unknown, params?: core.ParseContext<core.$ZodIssue>): Promise<core.output<this>>;
@@ -86,7 +86,7 @@ export interface _ZodString<T extends core.$ZodStringInternals<unknown> = core.$
     minLength: number | null;
     maxLength: number | null;
     regex(regex: RegExp, params?: string | core.$ZodCheckRegexParams): this;
-    includes(value: string, params?: core.$ZodCheckIncludesParams): this;
+    includes(value: string, params?: string | core.$ZodCheckIncludesParams): this;
     startsWith(value: string, params?: string | core.$ZodCheckStartsWithParams): this;
     endsWith(value: string, params?: string | core.$ZodCheckEndsWithParams): this;
     min(minLength: number, params?: string | core.$ZodCheckMinLengthParams): this;

package/v4/core/core.d.cts

@@ -22,7 +22,20 @@ export type $brand<T extends string | number | symbol = string | number | symbol
         [k in T]: true;
     };
 };
-export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol> = T & Record<"_zod", Record<"output", output<T> & $brand<Brand>>>;
+export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol, Dir extends "in" | "out" | "inout" = "out"> = T & (Dir extends "inout" ? {
+    _zod: {
+        input: input<T> & $brand<Brand>;
+        output: output<T> & $brand<Brand>;
+    };
+} : Dir extends "in" ? {
+    _zod: {
+        input: input<T> & $brand<Brand>;
+    };
+} : {
+    _zod: {
+        output: output<T> & $brand<Brand>;
+    };
+});
 export declare class $ZodAsyncError extends Error {
     constructor();
 }

package/v4/core/core.d.ts

@@ -22,7 +22,20 @@ export type $brand<T extends string | number | symbol = string | number | symbol
         [k in T]: true;
     };
 };
-export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol> = T & Record<"_zod", Record<"output", output<T> & $brand<Brand>>>;
+export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol, Dir extends "in" | "out" | "inout" = "out"> = T & (Dir extends "inout" ? {
+    _zod: {
+        input: input<T> & $brand<Brand>;
+        output: output<T> & $brand<Brand>;
+    };
+} : Dir extends "in" ? {
+    _zod: {
+        input: input<T> & $brand<Brand>;
+    };
+} : {
+    _zod: {
+        output: output<T> & $brand<Brand>;
+    };
+});
 export declare class $ZodAsyncError extends Error {
     constructor();
 }

package/v4/mini/schemas.d.cts

@@ -8,7 +8,7 @@ export interface ZodMiniType<out Output = unknown, out Input = unknown, out Inte
         parent: boolean;
     }): this;
     register<R extends core.$ZodRegistry>(registry: R, ...meta: this extends R["_schema"] ? undefined extends R["_meta"] ? [core.$replace<R["_meta"], this>?] : [core.$replace<R["_meta"], this>] : ["Incompatible schema"]): this;
-    brand<T extends PropertyKey = PropertyKey>(value?: T): PropertyKey extends T ? this : this & Record<"_zod", Record<"output", core.output<this> & core.$brand<T>>>;
+    brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
     def: Internals["def"];
     parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>;
     safeParse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): util.SafeParseResult<core.output<this>>;

package/v4/mini/schemas.d.ts

@@ -8,7 +8,7 @@ export interface ZodMiniType<out Output = unknown, out Input = unknown, out Inte
         parent: boolean;
     }): this;
     register<R extends core.$ZodRegistry>(registry: R, ...meta: this extends R["_schema"] ? undefined extends R["_meta"] ? [core.$replace<R["_meta"], this>?] : [core.$replace<R["_meta"], this>] : ["Incompatible schema"]): this;
-    brand<T extends PropertyKey = PropertyKey>(value?: T): PropertyKey extends T ? this : this & Record<"_zod", Record<"output", core.output<this> & core.$brand<T>>>;
+    brand<T extends PropertyKey = PropertyKey, Dir extends "in" | "out" | "inout" = "out">(value?: T): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>;
     def: Internals["def"];
     parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>;
     safeParse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): util.SafeParseResult<core.output<this>>;