Support for ZodBranded.

Closes #286.

Author: ciscoheat

CHANGELOG.md

@@ -7,11 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support for Zod [branded types](https://zod.dev/?id=brand) in schemas. ([#286](https://github.com/ciscoheat/sveltekit-superforms/pull/286))
+
 ### Fixed
 
-- Tainted fields were set to undefined when not needed, unnecessarily triggering client-side validation.
-- Schema transformations now updates the form data on the client depending on input type. Checkboxes, radio buttons and selects updates the data immediately. Other inputs waits until blurred. ([#298](https://github.com/ciscoheat/sveltekit-superforms/issues/298))
-- If in [SPA mode](https://superforms.rocks/concepts/spa), the `novalidate` attribute now only disables the browser validation constraints, not the entire client-side validation.
+- Tainted fields were set to undefined when not needed, unwantingly triggering client-side validation.
+- Schema transformations now updates the form data depending on input type. Checkboxes, radio buttons and selects updates the data immediately. Other inputs waits until blurred. ([#298](https://github.com/ciscoheat/sveltekit-superforms/issues/298))
+- In [SPA mode](https://superforms.rocks/concepts/spa), the `novalidate` attribute now only disables the browser validation constraints, not the entire client-side validation. ([#297](https://github.com/ciscoheat/sveltekit-superforms/discussions/297))
 
 ## [1.11.0] - 2023-11-28
 

src/index.test.ts

@@ -221,12 +221,14 @@ test('Optional values', async () => {
 
 test('Branded values', async () => {
   const schema = z.object({
-    name: z.string().brand('name'),
+    name: z.string().brand('name')
   });
 
   const data = new FormData();
   data.append('name', 'Name');
+
   const output = await superValidate(data, schema);
+
   expect(output.valid).equals(true);
   expect(output.message).toBeUndefined();
   expect(output.data.name).equals('Name');

src/lib/schemaEntity.ts

@@ -20,7 +20,8 @@ import type {
   ZodNumber,
   ZodDate,
   ZodArray,
-  ZodPipeline
+  ZodPipeline,
+  ZodBranded
 } from 'zod';
 
 import type { SuperValidateOptions } from './superValidate.js';
@@ -97,23 +98,34 @@ export function unwrapZodType(zodType: ZodTypeAny): ZodTypeInfo {
   //let i = 0;
   while (_wrapped) {
     //console.log(' '.repeat(++i * 2) + zodType.constructor.name);
-    if (zodType._def.typeName == 'ZodNullable') {
-      isNullable = true;
-      zodType = (zodType as ZodNullable<ZodTypeAny>).unwrap();
-    } else if (zodType._def.typeName == 'ZodDefault') {
-      hasDefault = true;
-      defaultValue = zodType._def.defaultValue();
-      zodType = zodType._def.innerType;
-    } else if (zodType._def.typeName == 'ZodOptional') {
-      isOptional = true;
-      zodType = (zodType as ZodOptional<ZodTypeAny>).unwrap();
-    } else if (zodType._def.typeName == 'ZodEffects') {
-      if (!effects) effects = zodType as ZodEffects<ZodTypeAny>;
-      zodType = zodType._def.schema;
-    } else if (zodType._def.typeName == 'ZodPipeline') {
-      zodType = (zodType as ZodPipeline<ZodTypeAny, ZodTypeAny>)._def.out;
-    } else {
-      _wrapped = false;
+    switch (zodType._def.typeName) {
+      case 'ZodNullable':
+        isNullable = true;
+        zodType = (zodType as ZodNullable<ZodTypeAny>).unwrap();
+        break;
+      case 'ZodDefault':
+        hasDefault = true;
+        defaultValue = zodType._def.defaultValue();
+        zodType = zodType._def.innerType;
+        break;
+      case 'ZodOptional':
+        isOptional = true;
+        zodType = (zodType as ZodOptional<ZodTypeAny>).unwrap();
+        break;
+      case 'ZodEffects':
+        if (!effects) effects = zodType as ZodEffects<ZodTypeAny>;
+        zodType = zodType._def.schema;
+        break;
+      case 'ZodPipeline':
+        zodType = (zodType as ZodPipeline<ZodTypeAny, ZodTypeAny>)._def.out;
+        break;
+      case 'ZodBranded':
+        zodType = (
+          zodType as ZodBranded<ZodTypeAny, string | number | symbol>
+        ).unwrap();
+        break;
+      default:
+        _wrapped = false;
     }
   }
 

src/lib/superValidate.ts

@@ -196,40 +196,38 @@ function formDataToValidation<T extends AnyZodObject>(
     typeInfo: ZodTypeInfo
   ): unknown {
     const newValue = valueOrDefault(value, false, true, typeInfo);
-    const zodType: ZodTypeAny =
-      typeInfo.zodType._def.typeName === 'ZodBranded'
-        ? (typeInfo.zodType as ZodBranded<any, any>).unwrap()
-        : typeInfo.zodType;
+    const zodType = typeInfo.zodType;
+    const typeName = zodType._def.typeName;
 
     // If the value was empty, it now contains the default value,
     // so it can be returned immediately, unless it's boolean, which
     // means it could have been posted as a checkbox.
-    if (!value && zodType._def.typeName != 'ZodBoolean') {
+    if (!value && typeName != 'ZodBoolean') {
       return newValue;
     }
 
-    //console.log(`FormData field "${field}" (${zodType._def.typeName}): ${value}`
+    //console.log(`FormData field "${field}" (${typeName}): ${value}`
 
-    if (zodType._def.typeName == 'ZodString') {
+    if (typeName == 'ZodString') {
       return value;
-    } else if (zodType._def.typeName == 'ZodNumber') {
+    } else if (typeName == 'ZodNumber') {
       return (zodType as ZodNumber).isInt
         ? parseInt(value ?? '', 10)
         : parseFloat(value ?? '');
-    } else if (zodType._def.typeName == 'ZodBoolean') {
+    } else if (typeName == 'ZodBoolean') {
       return Boolean(value == 'false' ? '' : value).valueOf();
-    } else if (zodType._def.typeName == 'ZodDate') {
+    } else if (typeName == 'ZodDate') {
       return new Date(value ?? '');
-    } else if (zodType._def.typeName == 'ZodArray') {
+    } else if (typeName == 'ZodArray') {
       const arrayType = unwrapZodType(zodType._def.type);
       return parseFormDataEntry(field, value, arrayType);
-    } else if (zodType._def.typeName == 'ZodBigInt') {
+    } else if (typeName == 'ZodBigInt') {
       try {
         return BigInt(value ?? '.');
       } catch {
         return NaN;
       }
-    } else if (zodType._def.typeName == 'ZodLiteral') {
+    } else if (typeName == 'ZodLiteral') {
       const literalType = typeof (zodType as ZodLiteral<unknown>).value;
 
       if (literalType === 'string') return value;
@@ -241,12 +239,12 @@ function formDataToValidation<T extends AnyZodObject>(
         );
       }
     } else if (
-      zodType._def.typeName == 'ZodUnion' ||
-      zodType._def.typeName == 'ZodEnum' ||
-      zodType._def.typeName == 'ZodAny'
+      typeName == 'ZodUnion' ||
+      typeName == 'ZodEnum' ||
+      typeName == 'ZodAny'
     ) {
       return value;
-    } else if (zodType._def.typeName == 'ZodNativeEnum') {
+    } else if (typeName == 'ZodNativeEnum') {
       const zodEnum = zodType as ZodNativeEnum<EnumLike>;
 
       if (value !== null && value in zodEnum.enum) {
@@ -260,11 +258,11 @@ function formDataToValidation<T extends AnyZodObject>(
         return value;
       }
       return undefined;
-    } else if (zodType._def.typeName == 'ZodSymbol') {
+    } else if (typeName == 'ZodSymbol') {
       return Symbol(String(value));
     }
 
-    if (zodType._def.typeName == 'ZodObject') {
+    if (typeName == 'ZodObject') {
       throw new SuperFormError(
         `Object found in form field "${field}". ` +
           `Set the dataType option to "json" and add use:enhance on the client to use nested data structures. ` +