Merge pull request #56 from volverjs/feature/optional

Add support for `zod.optional()` to `defaultObjectBySchema()`

package.json

@@ -64,7 +64,7 @@
  "credits": "npx @opengovsg/credits-generator"
  },
  "peerDependencies": {
- "@volverjs/ui-vue": "0.0.10-beta.36",
+ "@volverjs/ui-vue": "0.0.10-beta.41",
  "@vueuse/core": "^10.11.0",
  "ts-dot-prop": "^2.1.4",
  "vue": "^3.4.29",

src/utils.ts

@@ -14,7 +14,7 @@ import {
 import type { FormSchema } from './types'
 
 export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema, original: Partial<z.infer<Schema>> & Record<string, unknown> = {}): Partial<z.infer<Schema>> {
- const getInnerType = <Type extends ZodTypeAny>(
+ const getSchemaInnerType = <Type extends ZodTypeAny>(
  schema:
  | Type
  | ZodEffects<Type>
@@ -30,7 +30,23 @@ export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema,
  }
  return toReturn
  }
- const innerType = getInnerType<AnyZodObject>(schema)
+ const isSchemaOptional = <Type extends ZodTypeAny>(
+ schema:
+ | Type
+ | ZodEffects<Type>
+ | ZodEffects<ZodEffects<Type>>
+ | ZodOptional<Type>,
+ ) => {
+ let toReturn = schema
+ while (toReturn instanceof ZodEffects) {
+ toReturn = toReturn.innerType()
+ }
+ if (toReturn instanceof ZodOptional) {
+ return true
+ }
+ return false
+ }
+ const innerType = getSchemaInnerType<AnyZodObject>(schema)
  const unknownKeys
  = innerType instanceof ZodObject
  ? innerType._def.unknownKeys === 'passthrough'
@@ -41,7 +57,8 @@ export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema,
  (Object.entries(innerType.shape) as [string, ZodTypeAny][]).map(
  ([key, subSchema]) => {
  const originalValue = original[key]
- let innerType = getInnerType(subSchema)
+ const isOptional = isSchemaOptional(subSchema)
+ let innerType = getSchemaInnerType(subSchema)
  let defaultValue: Partial<z.infer<Schema>> | undefined
  if (innerType instanceof ZodDefault) {
  defaultValue = innerType._def.defaultValue()
@@ -53,6 +70,9 @@ export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema,
  ) {
  return [key, originalValue]
  }
+ if ((originalValue === undefined || originalValue === null) && isOptional) {
+ return [key, defaultValue]
+ }
  if (innerType instanceof ZodSchema) {
  const parse = subSchema.safeParse(originalValue)
  if (parse.success) {
@@ -64,7 +84,7 @@ export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema,
  && Array.isArray(originalValue)
  && originalValue.length
  ) {
- const arrayType = getInnerType(innerType._def.type)
+ const arrayType = getSchemaInnerType(innerType._def.type)
  if (arrayType instanceof ZodObject) {
  return [
  key,
@@ -82,7 +102,7 @@ export function defaultObjectBySchema<Schema extends FormSchema>(schema: Schema,
  }
  }
  if (innerType instanceof ZodRecord && originalValue) {
- const valueType = getInnerType(innerType._def.valueType)
+ const valueType = getSchemaInnerType(innerType._def.valueType)
  if (valueType instanceof ZodObject) {
  return [key, Object.keys(originalValue).reduce((acc: Record<string, unknown>, recordKey: string) => {
  acc[recordKey] = defaultObjectBySchema(valueType, originalValue[recordKey])