feat: support catchall

README.md

@@ -79,10 +79,14 @@ options:
 
 ## Options
 
-Both `zerialize` and `dezerialize` accept an options object with the same properties.
+Both `zerialize` and `dezerialize` accept an options object with the
+same properties.
 
-Since Zod does not allow the specification of the names of effects (refinements, transforms, and preprocesses), we allow you to supply as options maps of names to effects so that these can be part of serialization and deserialization. Note that due to technical limitations, we cannot support the regular `refine()` method (and it will be ignored) but `superRefine()` is supported. If none of these options are supplied,
-the effects will be omitted.
+Since Zod does not allow the specification of the names of effects
+(refinements, transforms, and preprocesses), we allow you to supply
+as options maps of names to effects so that these can be part of
+serialization and deserialization. If none of these options are
+supplied, the effects will be omitted.
 
 Properties:
 
@@ -109,6 +113,10 @@ by this library (any property could be targeted by one's references).
 
 ## Caveats
 
-- lazy and brand are omitted
-- pipeline and catch types are unwrapped
-- native enums are turned into enums
+- `brand` is not supportable and omitted
+- `lazy`, `pipeline` and `catch` types are unwrapped
+- native enums are turned into `enum`s
+- Due to technical limitations, we cannot support the regular
+  `refine()`, `custom()` and `instanceof` methods (and they will be
+  ignored), but these are really just implementations of `superRefine()`
+  which is supported

src/dezerialize.ts

@@ -364,7 +364,9 @@ const dezerializers = {
       }
     >;
 
-    if (shape.unknownKeys === "strict") {
+    if (shape.catchall) {
+      i = i.catchall(d(shape.catchall, opts));
+    } else if (shape.unknownKeys === "strict") {
       i = i.strict();
     } else if (shape.unknownKeys === "passthrough") {
       i = i.passthrough();

src/index.test.ts

@@ -54,6 +54,17 @@ test.each([
       },
     },
   }),
+  p(z.object({ name: z.string() }).catchall(z.number()), {
+    type: "object",
+    properties: {
+      name: {
+        type: "string",
+      },
+    },
+    catchall: {
+      type: "number",
+    },
+  }),
   p(z.number().catch(42), { type: "number" }),
 
   p(z.string(), { type: "string" }),

src/schema.zodex

@@ -407,6 +407,13 @@
                 },
                 "isOptional": true
               },
+              "catchall": {
+                "type": "union",
+                "options": [{
+                  "$ref": "#/$defs/reference-or-type"
+                }],
+                "isOptional": true
+              },
               "unknownKeys": {
                 "type": "enum",
                 "values": ["strict", "strip", "passthrough"],

src/types.ts

@@ -112,11 +112,13 @@ export type SzArray<T extends SzType = SzType> = {
   maxLength?: number;
 };
 export type SzObject<
-  T extends Record<string, SzType> = Record<string, SzType>
+  T extends Record<string, SzType> = Record<string, SzType>,
+  U extends SzType = SzType
 > = {
   type: "object";
   properties?: T;
   unknownKeys?: "strict" | "strip" | "passthrough";
+  catchall?: U;
 };
 
 export type SzUnion<Options extends [SzType, ...SzType[]] = [SzType]> = {
@@ -210,7 +212,7 @@ export type SzType = (
   | SzPrimitive
   | SzLiteral<any>
   | SzArray<any>
-  | SzObject<any>
+  | SzObject<any, any>
   | SzUnion<any>
   | SzDiscriminatedUnion<any, any>
   | SzIntersection<any, any>

src/zerialize.ts

@@ -377,6 +377,14 @@ const zerializers = {
 
     return {
       type: "object",
+      ...(def.catchall._def.typeName === "ZodNever"
+        ? {}
+        : {
+            catchall: s(def.catchall, {
+              ...opts,
+              paths: [...opts.paths, "catchall"],
+            }),
+          }),
       ...(def.unknownKeys === "strip"
         ? {}
         : {