Backport ez.raw() fix for v19

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Version 19
 
+### v19.3.1
+
+- Fixed: the output type of the `ez.raw()` schema (without an argument) was missing the `raw` property (since v19.0.0).
+
 ### v19.3.0
 
 - Feat: Supporting `vitest` version 2:

package.json

@@ -185,5 +185,6 @@
     "swagger-documentation",
     "zod",
     "validation"
-  ]
+  ],
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
 }

src/raw-schema.ts

@@ -3,11 +3,15 @@ import { file } from "./file-schema";
 
 export const ezRawBrand = Symbol("Raw");
 
+const base = z.object({ raw: file("buffer") });
+
 /** Shorthand for z.object({ raw: ez.file("buffer") }) */
-export const raw = <S extends z.ZodRawShape>(extra: S = {} as S) =>
-  z
-    .object({ raw: file("buffer") })
-    .extend(extra)
-    .brand(ezRawBrand as symbol);
+export function raw(): z.ZodBranded<typeof base, symbol>;
+export function raw<S extends z.ZodRawShape>(
+  extra: S,
+): z.ZodBranded<ReturnType<typeof base.extend<S>>, symbol>;
+export function raw(extra?: z.ZodRawShape) {
+  return (extra ? base.extend(extra) : base).brand(ezRawBrand);
+}
 
 export type RawSchema = ReturnType<typeof raw>;

tests/unit/raw-schema.spec.ts

@@ -0,0 +1,52 @@
+import { z } from "zod";
+import { ez } from "../../src";
+import { metaSymbol } from "../../src/metadata";
+import { ezRawBrand } from "../../src/raw-schema";
+import { describe, expect, expectTypeOf, test } from "vitest";
+
+describe("ez.raw()", () => {
+  describe("creation", () => {
+    test("should be an instance of branded object", () => {
+      const schema = ez.raw();
+      expect(schema).toBeInstanceOf(z.ZodBranded);
+      expect(schema._def[metaSymbol]?.brand).toBe(ezRawBrand);
+    });
+  });
+
+  describe("types", () => {
+    test("without extension", () => {
+      const schema = ez.raw();
+      expectTypeOf(schema._output).toMatchTypeOf<{ raw: Buffer }>();
+    });
+
+    test("with empty extension", () => {
+      const schema = ez.raw({});
+      expectTypeOf(schema._output).toMatchTypeOf<{ raw: Buffer }>();
+    });
+
+    test("with populated extension", () => {
+      const schema = ez.raw({ extra: z.number() });
+      expectTypeOf(schema._output).toMatchTypeOf<{
+        raw: Buffer;
+        extra: number;
+      }>();
+    });
+  });
+
+  describe("parsing", () => {
+    test("should accept buffer as the raw prop", () => {
+      const schema = ez.raw();
+      expect(schema.parse({ raw: Buffer.from("test"), extra: 123 })).toEqual({
+        raw: expect.any(Buffer),
+      });
+    });
+
+    test("should allow extension", () => {
+      const schema = ez.raw({ extra: z.number() });
+      expect(schema.parse({ raw: Buffer.from("test"), extra: 123 })).toEqual({
+        raw: expect.any(Buffer),
+        extra: 123,
+      });
+    });
+  });
+});